|
| 1 | +# Contributing to sra-pylib |
| 2 | + |
| 3 | +We welcome contributions to sra-pylib! Whether you want to report a bug, suggest an enhancement, or submit code changes, we appreciate your input. |
| 4 | + |
| 5 | +## Reporting Bugs |
| 6 | + |
| 7 | +If you encounter a bug in sra-pylib, please open an issue on our GitHub repository. Be sure to include as much detail as possible about the bug, including: |
| 8 | + |
| 9 | +- A description of what you were doing when the bug occurred |
| 10 | +- The error message you received (if applicable) |
| 11 | +- Steps to reproduce the bug |
| 12 | +- Any other relevant information |
| 13 | + |
| 14 | +Reporting bugs is highly appreciated as it helps us improve the library. |
| 15 | + |
| 16 | +## Suggesting Enhancements |
| 17 | + |
| 18 | +If you have an idea for how to improve sra-pylib, please open an [issue](https://github.com/Sayad-Uddin-Tahsin/sra-pylib/issues) on our GitHub repository. Be sure to include a detailed description of your suggestion and any relevant information. |
| 19 | + |
| 20 | +## Contributing Code |
| 21 | + |
| 22 | +If you want to contribute code to sra-pylib, please follow these steps: |
| 23 | + |
| 24 | +- Fork the sra-pylib repository on GitHub. |
| 25 | +- Clone your fork of the repository to your local machine. |
| 26 | +- Create a new branch for your changes. |
| 27 | +- Make your changes and test them locally. |
| 28 | +- Push your changes to your fork of the repository. |
| 29 | +- Create a pull request to merge your changes into the main repository. |
| 30 | + |
| 31 | +Before submitting a pull request, please ensure that your code follows our coding style and that all tests pass. |
| 32 | + |
| 33 | +## Coding Style |
| 34 | + |
| 35 | +We follow the [Python Style Guide](https://peps.python.org/pep-0008/) for our Python code. Please ensure that your code follows this style guide before submitting a pull request. |
| 36 | + |
| 37 | +## Code of Conduct |
| 38 | + |
| 39 | +We expect all contributors to adhere to our [Code of Conduct](https://github.com/Sayad-Uddin-Tahsin/sra-pylib/blob/main/CODE_OF_CONDUCT.md). Please read it before contributing. |
| 40 | + |
| 41 | +Thank you for contributing to sra-pylib! |
0 commit comments