CONTRIBUTING.md

How to contribute

With the many games the B3 project supports, third party patches are essential to keep the project great. We want to keep it as easy as possible to contribute changes that get things working for your game. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Contributing issues

Issues submitted on Github must be technically documented with the aim that any contributor trying to fix your issue should have enough information to understand and reproduce the issue and validate the fix.

• Make sure you have a GitHub account
• Search for a similar issue
• Submit your issue, assuming one does not already exist.
• Clearly describe the issue including :
  1. steps to reproduce
  2. expected results
  3. actual results
• Make sure you fill in the earliest version number of B3 that you know has the issue.

Contributing code

We prefer contributors to submit their code change throught Github pull requests. If you cannot you can submit patches on the B3 forums provided that your patch is small enought to be easily merged and tested.

getting the latest code

• Make sure you have a GitHub account
• Create a topic branch from where you want to base your work.
  • Only target release branches if you are certain your fix must be on that branch.
  • To quickly create a topic branch based on master; git branch fix/master/my_contribution master then checkout the new branch with git checkout fix/master/my_contribution. Please avoid working directly on the master branch.
• Make commits of logical units.
• Make sure your commit messages are in the proper format.

testing

If you can :

• Make sure you have added the necessary tests for your changes.
• Run all the tests to assure nothing else was accidentally broken.

submitting your changes

• Push your changes to a topic branch in your fork of the repository.
• Submit a pull request to the BigBrotherBot/big-brother-bot repository.
• Update the issue to mark that you have submitted code and are ready for it to be reviewed.
• Include a link to the pull request in the issue

Additional Resources

• Bug tracker
• General GitHub documentation
• GitHub pull request documentation

Do not depend on Github. Patches are not wanted? ;)
Better is:

'''
You do not like Github?
With Git, you can manage your own archive. Create a patch and paste it to a new ticket.
'''

lots of changes.
I added a paragraph on how to submit classical patches on the B3 forums.