The following is a set of guidelines for contributing to 'Compose Transducers'. Please spend several minutes in reading these guidelines before you create an issue or pull request.
Anyway, these are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
It's a great idea to read Eric Steven Raymond's How To Ask Questions The Smart Way twice before asking a question. But if you are busy now, I recommend to read Don't post homework questions first.
The following guidelines are about How to avoid Homework Questions.
Please read the documentation closely. Most answers will be here but if its not clear let me know!
It is a good habit which will save maintainers' time. Thank you!
It would be helpful to provide a demo which can re-produce the bug 100%. Please fork this project and re-produce the bug you met in the repo or provide detailed instructions to reproduce the issue. Then, create an issue. The most important thing is: double check before claiming that you have found a bug.
If you believe that 'Compose Transducers' should provide some features, but it does not. You could create an issue to discuss.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
It's welcomed to pull request. And there are some tips about that:
- It is a good habit to create a feature request issue to discuss whether the feature is necessary before you implement it. However, it's unnecessary to create an issue to claim that you found a typo or improved the readability of documentation, just create a pull request.
- Rebase before creating a PR to keep commit history clear.
- Add some descriptions and refer relative issues for you PR.