Existing code style may not be consistent everywhere. We provide a
configuration file for indent that should be OK for
new files. Be careful when applying it on existing files, indent may be
zealous and modify more lines than expected.
The code must comply with PEP8.
Running tox -e pep8 will tell what is wrong.
When using abbreviations, try to be consistent. Here is a list of abbreviation commonly used in the existing code base.
- acct: account
- cid: container ID
- cs: conscience
- err: error
- exc: exception
- m0: meta0
- m1: meta1
- m2: meta2
- ns: namespace
- req: request
- reqid: request ID
- resp: response
Pull requests implementing new features should be targeted at the master branch.
Pull requests fixing bugs should be targeted at the maintenance branch for the version you are using. Or better, if it applies, targeted at the oldest alive maintenance branch (end-of-life branches have the prefix "eol-"). Old maintenance branches are merged into more recent branches from time to time.
OpenIO's maintainers usually rebase and merge pull requests (instead of just merging them). This avoids creating too many merge commits, since pull requests often contain only one commit.
When creating the pull request on GitHub, please select "Allow edits from maintainers." so the maintainers can rebase it if needed.
If a pull request is still work-in-progress, prefix the title with "[WIP]", and the maintainers won't touch it.