paulin/bonobo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

new: FAQ section in documentation (#27).

Browse Source
This commit is contained in:
Romain Dorgueil
2017-04-23 19:41:05 +02:00
parent e641cc573a
commit 3fbe12fa66
7 changed files with 218 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/contribute/index.rst
View File

@ -4,15 +4,20 @@ Contributing
Contributing to bonobo is simple. Although we don't have a complete guide on this topic for now, the best way is to fork
the github repository and send pull requests.
Keep the following points in mind:
A few guidelines...
* Although we will ask for 100% backward compatibility starting from 1.0 (following semantic versionning principles),
pre-1.0 versions should do their best to keep compatibility between versions. Wehn in doubt, open a github issue
to discuss things.
* Starting at 1.0, the system needs to be 100% backward compatible. Best way to do so is to ensure the actual expected
behavior is unit tested before making any change. See http://semver.org/.
* There can be changes before 1.0, even backward incompatible changes. There should be a reason for a BC break, but
I think it's best for the speed of development right now.
* The core should stay as light as possible.
* Coding standards are enforced using yapf. That means that you can code the way you want, we just ask you to run
`make format` before committing your changes so everybody follows the same conventions.
* General rule for anything you're not sure about is "open a github issue to discuss the point".
* More formal proposal process will come the day we feel the need for it.
A very drafty roadmap is available in the readme.
Issues: https://github.com/python-bonobo/bonobo/issues
Roadmap: https://www.bonobo-project.org/roadmap
Slack: https://bonobo-slack.herokuapp.com/