Andy Mikhailenko avatar Andy Mikhailenko committed 2992d09

Added CONTRIBUTING file.

Comments (0)

Files changed (2)

+Development Workflow
+====================
+
+1. File a ticket at Bitbucket (optional).
+2. Fork main repository.
+3. Write tests and code that passes them. (Check with ./run_tests.py)
+4. Document the code: add comments and docstrings so that anyone can easily
+   understand what does your code do and why.
+5. Ensure that the new code is fully covered with tests.
+6. Send pull request.
 ---------
 
 This application was initially created by Andy Mikhailenko and then improved
-by other developers. They are listed in the AUTHORS file.
+by other developers. They are listed in :file:`AUTHORS`.
 
 Please feel free to file issues and/or submit patches.
 
+See :file:`CONTRIBUTING` for hints related to the preferred workflow.
+
 Licensing
 ---------
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.