Issues are very valuable to this project.
- Ideas are a valuable source of contributions others can make
- Problems show where this project is lacking
- With a question you show where contributors can improve the user experience
Thank you for creating them.
The project mantainers will try to answer you as soon as possible, please be patient while waiting for an answer 🙂
When possible, use the available templates to write your ideas.
Pull requests are a great way to get your features/fix into this repository.
Anyone is more than welcome to propose changes to the source code; the maintainers will try to follow up and review the proposal. After the changes are reviewed and approved, the PR will be merged.
Keep in mind that a Pull Request, to be merged, needs to respect the following things:
It should be clear which problem you're trying to solve with your contribution.
Please include a detailed description of what you want to achieve, to help the reviewers understand the context of your work 🤝.
- There are no spelling mistakes 📶
- It reads well 📖
- Repository style is followed ⛏️
The project has a wiki where are stored detailed information on how to use the package.
Please keep in mind that it's nice to included, in the description or in a separate comment, the .md content that can be added to the wiki.
With this addtion, reviewers will be able to plan the feature presentation to the end users.
The Contributing template was adapted from:
github/PurpleBooth/a-good-readme-template