Contributing to Baum
Thinking of contributing? Maybe you've found some nasty bug? That's great news!
Reporting a Bug
- Update to the most recent master release if possible. The bug you're experiencing may have already been fixed.
- Search for similar issues. It's possible somebody has encountered the same bug already.
- If you keep experiencing the issue and cannot find a similar bug report: Open a new issue and report the bug as explicitly as you can.
- If possible, try to add a link to a gist with some failing code and/or stack traces or submit a Pull Request with a failing test. Better yet, take a stab at fixing the bug yourself if you can!
The more information you provide, the easier it is to validate that there is a bug and the faster it is for me or anyone to provide a fix.
Requesting a Feature
- Search Issues for similar feature requests. It's possible somebody has already asked for this feature or provided a pull request that's still in discussion.
- Provide a clear and detailed explanation of the feature you want and why it's important to add.
- If the feature is complex, consider writing some initial documentation for it. This will help everyone understand its use cases and if it is finally implemented it will serve as the base for its documentation.
- Attempt a Pull Request. If you're at all able, start writing some code. Please understand that this is an open source side-project, so the time devoted to it is quite limited. If you can write some code then that will speed the process greatly.
- Fork & clone the project:
git clone email@example.com:your-username/baum.git.
- Run the tests and make sure that they pass with your setup:
- Create your bugfix/feature branch and code away your changes. Add tests for your changes. If you're adding functionality or fixing a bug, tests make it easier for the merge to be possible. Also, they make sure I don't break your changes incidentally.
- Make sure all the tests still pass:
- Commit your changes. If your pull request fixes an specific issue make sure you say so in the commit message. For example:
git commit -m "Fix auto-imploding nasty bug. Fixes #90.".
- Push to your fork and submit a pull request. Please provide some explanation of why you made the changes you made. For new features make sure to explain a standard use case.
At this point you're waiting on me to respond. I'd like to say I'd get back to you immediately but understand that it may not be possible for me to do that. Please, be patient. I may suggest some changes or improvements or even complete alternative implementations.