Contribute to AskOmics¶
If you have an idea for a feature to add or an approach for a bugfix, it is best to communicate with developers early. The most common venues for this are GitHub issues.
All changes to AskOmics should be made through pull requests to this repository.
For the askomics repository to your account. To keep your copy up to date, you need to frequently sync your fork:
git remote add upstream https://github.com/askomics/flaskomics git fetch upstream git checkout master git merge upstream/master
Then, create a new branch for your new feature
git checkout -b my_new_feature
Commit and push your modification to your fork. If your changes modify code, please ensure that is conform to AskOmics style
Write tests for your changes, and make sure that they passes.
Open a pull request against the master branch of askomics. The message of your pull request should describe your modifications (why and how).
The pull request should pass all the continuous integration tests which are automatically run by Github using Travis CI. The coverage must be at least remain the same (but it’s better if it increases)
test.sh script to lint and test the code. Don’t PR if linting or testing don’t pass.
Coding style guidelines¶
Ensure all user-enterable strings are unicode capable. Use only English language for everything (code, documentation, logs, comments, …)
We follow PEP-8, with particular emphasis on the parts about knowing when to be inconsistent, and readability being the ultimate goal.
- Whitespace around operators and inside parentheses
- 4 spaces per indent, spaces, not tabs
- Include docstrings on your modules, class and methods
- Avoid from module import *. It can cause name collisions that are tedious to track down.
- Class should be in
CamelCase, methods and variables in
Contribute to docs¶
all the documentation (including what you are reading) can be found here. Files are on the AskOmics repository.
To preview the docs, run
cd flaskomics # source the askomics virtual env source venv/bin/activate cd docs make html
html files are in