Skip to content

contributing.md

Latest commit

 

History

History
72 lines (52 loc) · 3.12 KB

contributing.md

File metadata and controls

72 lines (52 loc) · 3.12 KB

Contributing to PiDualTx

Thank you for your interest in contributing to the PiDualTx project! We welcome contributions from the community to help improve the application. This document outlines the guidelines for contributing to the project.

Table of Contents

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create your own copy of the project.
  2. Clone Your Fork: Clone your forked repository to your local machine: 
    git clone https://github.com/KOSASIH/pidualtx.git
cd pidualtx
  3. Set Up the Development Environment: Follow the setup guide to set up your local development environment.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please be respectful and considerate in your interactions with others.

How to Contribute

Reporting Issues

If you encounter a bug or issue, please report it by creating a new issue in the repository. Provide as much detail as possible, including:

  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots or logs, if applicable

Feature Requests

We welcome suggestions for new features! If you have an idea for a feature, please create a new issue and describe the feature in detail. Include the problem it solves and any potential use cases.

Pull Requests

  1. Create a New Branch: Create a new branch for your feature or bug fix: 
    git checkout -b feature/my-new-feature
  2. Make Your Changes: Implement your changes and ensure that your code adheres to the project's coding standards.
  3. Test Your Changes: Run tests to ensure that your changes do not break existing functionality.
  4. Commit Your Changes: Commit your changes with a clear and descriptive commit message: 
    git commit -m "Add new feature: my new feature"
  5. Push to Your Fork: Push your changes to your forked repository: 
    git push origin feature/my-new-feature
  6. Create a Pull Request: Go to the original repository and create a pull request. Provide a clear description of your changes and reference any related issues.

Development Guidelines

  • Code Style: Follow the coding style used in the project. Use consistent indentation, naming conventions, and comments.
  • Documentation: Update the documentation as needed to reflect your changes. This includes updating API documentation, setup instructions, and any relevant markdown files.
  • Testing: Write tests for new features and ensure that all existing tests pass. Use the testing framework specified in the project.

Thank You!

We appreciate your contributions to the PiDualTx project! Together, we can make this application better for everyone. If you have any questions, feel free to reach out to the maintainers.

Happy coding!