|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Thank you for being so interested in contributing to the `ewrap` package. I appreciate your willingness to share your knowledge and experience with me. |
| 4 | + |
| 5 | +Here is a brief guideline about how you can help improving the library, adding new features, fixing bugs. |
| 6 | + |
| 7 | +## How to Contribute |
| 8 | + |
| 9 | +### Reporting Issues |
| 10 | + |
| 11 | +One of the simplest ways to contribute is by reporting issues. If you encounter a problem with one of the tools, find a mistake in the documentation, or believe that a best practice needs to be updated, please open an issue on our GitHub repository. |
| 12 | + |
| 13 | +### Submitting Changes |
| 14 | + |
| 15 | +If you want to directly contribute to the project by adding new tools, updating documentation, or proposing new best practices, follow these steps: |
| 16 | + |
| 17 | +- **Fork the Repository:** Start by forking the project repository into your GitHub account. |
| 18 | +- **Create a Branch:** Create a new branch in your forked repository. It's good practice to name the branch according to the feature or fix you're implementing. |
| 19 | +- **Make Your Changes:** Add, edit, or delete files in your branch to implement the changes you want to make. |
| 20 | +- **Commit Your Changes:** Make sure to write clear, concise commit messages describing your changes. |
| 21 | +- **Push Your Changes:** Push your branch and its new commits to your forked repository on GitHub. |
| 22 | +- **Create a Pull Request:** Open a pull request from your forked repository to the main project repository. Please provide a detailed description of the changes you've made and the reasons behind them. |
| 23 | + |
| 24 | +## Reviewing Pull Requests |
| 25 | + |
| 26 | +Another way to contribute is by reviewing pull requests submitted by others. Look over the proposed changes, test them if possible, and leave feedback. |
| 27 | + |
| 28 | +## Contribution Guidelines |
| 29 | + |
| 30 | +To ensure that contributions are consistent and aligned with the project's objectives, please follow these guidelines: |
| 31 | + |
| 32 | +**Respect the Project's Scope:** All contributions should aim to improve the service stability, security, performance. Contributions that align with this objective may be accepted. |
| 33 | + |
| 34 | +**Follow Best Practices:** When contributing code, adhere to the coding style and practices established in the project. |
| 35 | + |
| 36 | +**Provide Detailed Information:** When reporting issues or submitting pull requests, provide as much relevant information as possible. This will help maintainers and other contributors understand your changes or your problems. |
| 37 | + |
| 38 | +**Respect Others:** Be kind and respectful towards other community members. Avoid disrespectful language and behavior. |
| 39 | + |
| 40 | +## Conclusion |
| 41 | + |
| 42 | +Participating in open-source projects like this one can be an enriching experience. You have the opportunity to enhance your abilities while also making a valuable contribution to a resource that positively impacts the greater community. |
0 commit comments