This repository uses the forking model
for collaboration. In this model,
each developer forks the main (sorgerlab/indra) repository, pushes code
only to branches in their own fork, and then submits pull requests to
sorgerlab. After cloning your own fork of indra, you should add sorgerlab
as a remote to be able to track the latest changes by doing
git remote add sorgerlab https://github.com/sorgerlab/indra.git
When a PR is submitted from a branch, any further changes can be pushed to that same branch even after the PR has been opened, and those changes are automatically appended to the PR. Please always check the box on Github allowing the maintainers of the repo to make changes to the PR.
In addition, as a convention, we only merge PRs whose branches are rebased
on top of the latest sorgerlab/master. This means that instead of merging
sorgerlab/master into your own branch to resolve conflicts, you should always
rebase on top of sorgerlab/master and force push your branches if
needed (you can do this even if a PR from that branch is already open).
Consistent with this convention, in general, you should not use git pull
to update your local fork. Rather, use git fetch --all,
git merge --ff-only, git rebase or git reset --hard as needed to
get to the desired state. PRs are always merged using a separate merge commit,
ensuring that merges clearly correspond to the inclusion of a specific
feature or the fixing of a specific issue. In some cases, for instance, if
a branch includes many trial and error commits, the maintainers may squash
some commits before merging.
Always submit PRs via the sorgerlab repository. Give your PR a concise and clear title that describes without excessive detail what the PR does. You should give more details in the description, pointing out the important changes made and any additional remarks that are relevant. If the PR fixes any issues, you can add "Fixes #xxx" to the text of the PR, which, when merged, will also automatically close the issue. The branch itself should have a short but recognizable name related to the feature it adds or fixes rather than a generic name (e.g. patch, fix).
The commit message should typically consist of a single line describing what the commit does. A good commit is one for which a clear and concise commit message is necessary and sufficient - irrespective of how much code the commit changes. A good set of guidelines can be found here.
Please follow PEP8 guidelines when implementing new code. If modifying existing code, we ask that you do not mix extensive stylistic changes with meaningful code changes. Any stylistic changes should be submitted in a separate PR.
The most important stylistic requirements are:
- use 4 spaces for indentation instead of tabs
- wrap lines to max 80 characters
- name variables and functions all lowercase with underscore as a separator
(e.g.
some_variable) - name classes with starting letters capitalized and no separator
(e.g.
SomeClass)
In addition, functions or classes that are not meant to be part of the API of the given module (for instance helper functions that a user wouldn't directly call) should be prefixed with an underscore. These then won't show up and clutter the auto-generated API documentation.
Up to release 1.10, the core modules of INDRA used to be Python 2/3 cross-compatible. However, as of release 1.11, Python 2.x is not supported anymore. Compatibility with Python 3.5, however, is still maintained. This means that features only available in later versions of Python such as f-strings should not be used in code contributed to INDRA.
A requirement that is mostly automatically satisfied in a Python 3-only context
but is still important to keep in mind is that all strings within INDRA
should be represented, manipulated and passed around as unicode (simply str
in Python 3). Whenever a string is read from a source or written to some
output, it should be decoded and encoded, respectively. This concept is also
called the "unicode sandwich".
All API functions (i.e. functions that a user can call) and classes need to be documented via docstrings. Please follow the NumPy documentation style when adding docstrings to functions and classes.
The docstring
- is surrounded by triple double-quotes,
- starts with a one line short summary on the same line as the starting quotes,
- after the short summary and an empty line, can contain an arbitrary length extended summary,
- lists all arguments, their types and descriptions in a Parameters block
- lists all returned values, their types and descriptions in a Returns block
To verify that the documentation build is working, go into the doc folder
and run make html. Warnings and errors indicate any issues during the build
process. The resulting HTML documentation can be opened with a browser from
doc/_build/html/index.html and inspected to verify that it looks as
intended.
INDRA is tested using the nosetests script and nose/unittest tools.
See the nose documentation for more
details.
All new functionalities added should also be tested unless special
circumstances prevent testing. Similarly, fixed bugs should have regression
tests added. Normally, any test file with test in its
name and any functions/classes that have test/Test in their names in these
files will be automatically discovered and tested. Tests should generally be
included in indra/tests, and new tests should be placed in the appropriate
existing file, if possible. Otherwise, a new file using the test_a_module.py
naming convention. Where possible, tests should be short and focused. If the
newly added test requires special dependencies or other preliminary setup, the
.travis.yml configuration for Travis CI needs to be updated to make the test
work. Generally, PRs will not be merged unless all Travis tests are passing. In
some cases the PR will be merged if tests are failing, if the failures are
confirmed to be unrelated to the PR.
Instead of using print for printing information to stdout, use the logging
module to first create an approproately named logger,
as for instance logger = logging.getLogger(__name__) and then use the
appropriate level of logging (typically debug, info, warning or error) with
the logger object to print messages. The configuration of the logging format
is uniform across INDRA without further configuration needed for each
individual logger instance. In addition, by using __name__ to instantiate
the logger, the hierarchy of logger objects across the module is maintained
making it easier to control logging at various levels. Loggers not using
__name__ should only be used under special circumstances, for instance, if
the file is likely to be run as a standalone script rather than imported.
When adding new functionalities, using built-in Python libraries or packages that are already standard dependencies of INDRA are preferred. In case a new dependency needs to be used, that dependency needs to be
- added to the install list or one of the extras list in setup.py
- added to the installation instructions in the documentation if any special instructions are needed for setup
- either added to doc/conf.py as an installed dependency or mocked to make doc builds on readthedocs.io pass
- added to .travis.yml unless installed on Travis via setup.py
If a new submodule is added, that submodule needs to be
- listed in setup.py under packages to make sure it is included in installs
- referred to in the documentation explicitly to be included
If a new non-python file is added to the repository, it needs to be listed in MANIFEST.in to make sure it is included in installations.