Skip to content

Contributing Guidelines

Thank you for being so interested in contributing to the ewrap package. I appreciate your willingness to share your knowledge and experience with me.

Here is a brief guideline about how you can help improving the library, adding new features, fixing bugs.

How to Contribute

Reporting Issues

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.

Submitting Changes

If you want to directly contribute to the project by adding new tools, updating documentation, or proposing new best practices, follow these steps:

  • Fork the Repository: Start by forking the project repository into your GitHub account.
  • 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.
  • Make Your Changes: Add, edit, or delete files in your branch to implement the changes you want to make.
  • Commit Your Changes: Make sure to write clear, concise commit messages describing your changes.
  • Push Your Changes: Push your branch and its new commits to your forked repository on GitHub.
  • 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.

Reviewing Pull Requests

Another way to contribute is by reviewing pull requests submitted by others. Look over the proposed changes, test them if possible, and leave feedback.

Contribution Guidelines

To ensure that contributions are consistent and aligned with the project's objectives, please follow these guidelines:

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.

Follow Best Practices: When contributing code, adhere to the coding style and practices established in the project.

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.

Respect Others: Be kind and respectful towards other community members. Avoid disrespectful language and behavior.

Conclusion

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.