If you are new to Diofant, start with the Tutorial. If you are willing to contribute - it’s assumed you know the Python programming language and the Git Version Control System.
Guidelines for Contributing¶
This project adheres to No Code of Conduct. Contributions will be judged by their technical merit. Nothing else matters.
When opening a new issue, please take the following steps:
- Please search GitHub issues to avoid duplicate reports.
- If possible, try updating to master and reproducing your issue.
- Try to include a minimal reproducible test case as an example.
- Include any relevant details of your local setup (i.e. Python version, installed libraries).
All work should be submitted via Pull Requests (PR).
PR can be submitted as soon as there is code worth discussing.
Please put your work on the branch of your fork, not in the master branch. PR should generally be made against master.
One logical change per commit. Make good commit messages: short (<= 78 characters) one-line summary, then newline followed by verbose description of your changes. Please mention closed issues with commit message.
PR should include tests:
- Bugfixes should include regression tests.
- All new functionality should be tested, every new line should be covered by tests.
- Optionally, provide doctests to illustrate usage. But keep in mind, doctests are not tests. Think of them as examples that happen to be tested.
It’s good idea to be sure that all existing tests pass and you don’t break anything, so please run:
$ python setup.py test
Please also check for potential flaws in your Python code with:
$ pylint diofant
If your change affects documentation, please build it by:
$ python setup.py build_sphinx -W
and check that it looks as expected.
The Diofant project is a SymPy’s fork, so it could be handy to collect here some facts about SymPy and explain historical code conventions.
First, the SymPy project was hosted in SVN repository on the Google Code and our master branch include only commits, that added after moving project on the Github. But it’s not a problem for us - we keep old history on the branch sympy-svn-history. Also, you can see this history as part of master’s, if you clone our repo and simply do this:
$ git fetch origin 'refs/replace/*:refs/replace/*'
Please note, that we have dozens of references to SymPy issues in our
codebase. Such reference must be either a direct URL of the issue, or
a fully qualified reference in the Github format, like
sympy/sympy#123. Unqualified references like
123 — are reserved for Diofant’s issues. Functions for
regression tests should be named like
However, in the old Git history, before commit cbdd072,
please expect that
issue #123 or
issue 123 — are
references to the SymPy’s issues. The whole story is a little worse,
because before commit 6f68fa1 - such unqualified references
assume issues on the Google Code, not Github, unless other clearly
stated. SymPy issues from the Google Code were moved to the Github in
March 2014 (see sympy/sympy#7235). Transfered issue numbers were
shifted by 3099. I.e.
issue 123 in the history - does mean issue
sympy/sympy#3222 on Github.
Versioning and Release Procedure¶
Releasing a new version is done as follows:
Commit version update:
$ git commit -am 'Bump version to X.Y.Z'
Merge commit to the master branch.
Tag merge commit and push release tag:
$ git pull $ git tag -s vX.Y.Z $ git push origin vX.Y.Z
Labeling Issues and Pull Requests¶
Following table lists meanings of labels, including provided by Github:
|bug||an unexpected problem or unintended behavior|
|wrong answer||if mathematically wrong result was obtained|
|duplicate||indicates similar issues or pull requests|
|enhancement||new feature requests (or implementation)|
|good first issue||indicates a good issue for first-time contributors|
|help wanted||indicates that a maintainer wants help here|
|invalid||mark that a problem is no longer relevant|
|question||mark support request|
|wontfix||indicates that work won’t continue on this issue|