Skip to content

Commit

Permalink
Update the CONTRIBUTING section of the README and provide a CONTRIBUT…
Browse files Browse the repository at this point in the history
…ING file.
  • Loading branch information
etrepat committed Jul 3, 2014
1 parent ae9d7e5 commit 78a4abf
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 5 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to Baum

Thinking of contributing? Maybe you've found some nasty bug? That's great news!

## Reporting a Bug

1. Update to the most recent *master release* if possible. The bug you're experiencing may have already been fixed.
2. Search for similar issues. It's possible somebody has encountered the same bug already.
3. 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.
4. 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

1. Search [Issues](https://github.com/etrepat/baum/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.
2. Provide a clear and detailed explanation of the feature you want and why it's important to add.
3. 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.
4. 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.

## Pull Requests

1. Fork & clone the project: `git clone [email protected]:your-username/baum.git`.
2. Run the tests and make sure that they pass with your setup: `phpunit`.
3. 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.
4. Make sure all the tests still pass: `phpunit`.
5. 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."`.
6. 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.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -787,11 +787,13 @@ Feel free to browse the wiki after finishing this README:
Thinking of contributing? Maybe you've found some nasty bug? That's great news!
1. Fork the project:.
2. Create your bugfix/feature branch.
3. Code away your changes and, if you can, provide some tests.
4. Commit your changes & push to the branch.
5. Create a new Pull Request
1. Fork & clone the project: `git clone [email protected]:your-username/baum.git`.
2. Run the tests and make sure that they pass with your setup: `phpunit`.
3. Create your bugfix/feature branch and code away your changes. Add tests for your changes.
4. Make sure all the tests still pass: `phpunit`.
5. Push to your fork and submit new a pull request.
Please see the [CONTRIBUTING.md](https://github.com/etrepat/baum/blob/master/CONTRIBUTING.md) file for extended guidelines and/or recommendations.
## License
Expand Down

0 comments on commit 78a4abf

Please sign in to comment.