Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

43 lines (22 loc) · 2.97 KB
Raw

Contribution Guidelines

Thank you for considering contributing to PyArgWriter! We welcome contributions from the community to help make this project even better.

Before you start contributing, please read through these guidelines to ensure a smooth and effective collaboration process.

How to Contribute

  1. Create an Issue: Before starting work on a new feature or bug fix, please open an issue on the GitHub repository to discuss your proposal or report a bug. This helps prevent duplicated work and ensures that your contribution is aligned with the project's goals.

  2. Fork the Repository: If you're ready to work on an issue or feature, fork the PyArgWriter repository on GitHub.

  3. Create a Branch: Create a new branch in your forked repository for your contribution. Name the branch in a descriptive and meaningful way, e.g., feature/add-new-command.

  4. Coding Guidelines: Ensure that your code follows the project's coding standards and conventions. If your contribution involves code formatting, use tools like Black to maintain consistent code style.

  5. Write Tests: If your contribution involves new functionality or changes, write unit tests to cover your code. Make sure that the existing tests pass as well.

  6. Documentation: Update the documentation, including docstrings and README, to reflect any changes or new features introduced by your contribution.

  7. Commit Changes: Commit your changes with clear and concise commit messages. Reference the related issue or feature request in your commit message.

  8. Create a Pull Request: Once your changes are ready, create a Pull Request (PR) from your branch to the main branch of the PyArgWriter repository. Provide a detailed description of your changes, including the problem you're solving and the approach you've taken.

  9. Code Review: Your PR will undergo a review process. Maintain active communication during the review and be prepared to make necessary changes if requested.

  10. Continuous Integration: Ensure that all CI/CD checks pass successfully.

  11. Merge: Once your PR is approved, it will be merged into the main branch.

Code of Conduct

Please note that by contributing to PyArgWriter, you are expected to follow our Code of Conduct. We aim to create a respectful and inclusive community for all contributors.

Reporting Issues

If you encounter any issues or have questions about PyArgWriter, please feel free to open an issue. We appreciate your feedback and will do our best to address your concerns.

Contact

If you have any further questions or need assistance with contributing to PyArgWriter, please reach out via GitHub issues or contact the project maintainers directly.

Thank you for your contributions and for helping make PyArgWriter better for everyone!