ini2toml contributor’s guide.
This document focuses on getting any potential contributor familiarized with the development processes, but other kinds of contributions are also appreciated.
If you are new to using git or have never collaborated in a project previously, please have a look at contribution-guide.org. Other resources are also listed in the excellent guide created by FreeCodeCamp.
Please notice, all users and contributors are expected to be open, considerate, reasonable, and respectful. When in doubt, Python Software Foundation’s Code of Conduct is a good reference in terms of behavior guidelines.
If you experience bugs or general issues with
ini2toml, please have a look
on the issue tracker. If you don’t see anything useful there, please feel
free to fire an issue report.
Please don’t forget to include the closed issues in your search. Sometimes a solution was already reported, and the problem is considered solved.
New issue reports should include information about your programming environment (e.g., operating system, Python version) and steps to reproduce the problem. Please try also to simplify the reproduction steps to a very minimal example that still illustrates the problem you are facing. By removing other factors, you help us to identify the root cause of the issue.
You can help improve
ini2toml docs by making them more readable and coherent, or
by adding missing information and correcting mistakes.
ini2toml documentation uses Sphinx as its main documentation compiler.
This means that the docs are kept in the same repository as the
project code, in the form of reStructuredText files, and that any
documentation update is done in the same way was a code contribution.
Please notice that the GitHub web interface provides a quick way of
propose changes in
ini2toml’s files. While this mechanism can
be tricky for normal code contributions, it works perfectly fine for
contributing to the docs, and can be quite handy.
If you are interested in trying this method out, please navigate to
docs folder in the source repository, find which file you
would like to propose changes and click in the little pencil icon at the
top, to open GitHub’s code editor. Once you finish editing the file,
please write a message in the form at the bottom of the page describing
which changes have you made and what are the motivations behind them and
submit your proposal.
When working on documentation changes in your local machine, you can
compile them using
tox -e docs
and use Python’s built-in web server for a preview in your web browser
python3 -m http.server --directory 'docs/_build/html'
Understanding how the project works#
Submit an issue#
Before you work on any non-trivial code contribution it’s best to first create a report in the issue tracker to start a discussion on the subject. This often provides additional considerations and avoids unnecessary work.
Create an environment#
virtualenv <PATH TO VENV> source <PATH TO VENV>/bin/activate
conda create -n ini2toml python=3 six virtualenv pytest pytest-cov conda activate ini2toml
Clone the repository#
Create an user account on GitHub if you do not already have one.
Fork the project repository: click on the Fork button near the top of the page. This creates a copy of the code under your account on GitHub.
Clone this copy to your local disk:
git clone firstname.lastname@example.org:YourLogin/ini2toml.git cd ini2toml
You should run:
pip install -U pip setuptools -e .
to be able import the package under development in the Python REPL.
pip install pre-commit pre-commit install
ini2tomlcomes with a lot of hooks configured to automatically help the developer to check the code being written.
Implement your changes#
Create a branch to hold your changes:
git checkout -b my-feature
and start making changes. Never work on the main branch!
Start your work on this branch. Don’t forget to add docstrings to new functions, modules and classes, especially if they are part of public APIs.
Add yourself to the list of contributors in
When you’re done editing, do:
git add <MODIFIED FILES> git commit
to record your changes in git.
Please make sure to see the validation messages from
pre-commitand fix any eventual issues. This should automatically use flake8/black to check/fix the code style in a way that is compatible with the project.
Don’t forget to add unit tests and documentation in case your contribution adds an additional feature and is not just a bugfix.
Moreover, writing a descriptive commit message is highly recommended. In case of doubt, you can check the commit history with:
git log --graph --decorate --pretty=oneline --abbrev-commit --all
to look for recurring communication patterns.
Please check that your changes don’t break any unit tests with:
(after having installed
pip install toxor
You can also use
toxto run several other pre-configured tasks in the repository. Try
tox -avto see a list of the available checks.
Submit your contribution#
If everything works fine, push your local branch to GitHub with:
git push -u origin my-feature
Go to the web page of your fork and click “Create pull request” to send your changes for review.
Find more detailed information in creating a PR. You might also want to open the PR as a draft first and mark it as ready for review after the feedbacks from the continuous integration (CI) system or any required fixes.
The following tips can be used when facing problems to build or test the package:
Make sure to fetch all the tags from the upstream repository. The command
git describe --abbrev=0 --tagsshould return the version you are expecting. If you are trying to run CI scripts in a fork repository, make sure to push all the tags. You can also try to remove all the egg files or the complete egg folder, i.e.,
.eggs, as well as the
*.egg-infofolders in the
srcfolder or potentially in the root of your project.
toxmisses out when new dependencies are added, especially to
docs/requirements.txt. If you find any problems with missing dependencies when running a command with
tox, try to recreate the
toxenvironment using the
-rflag. For example, instead of:
tox -e docs
tox -r -e docs
Make sure to have a reliable
toxinstallation that uses the correct Python version (e.g., 3.7+). When in doubt you can run:
tox --version # OR which tox
virtualenv .venv source .venv/bin/activate .venv/bin/pip install tox .venv/bin/tox -e all
Pytest can drop you in an interactive session in the case an error occurs. In order to do that you need to pass a
--pdboption (for example by running
tox -- -k <NAME OF THE FALLING TEST> --pdb). You can also setup breakpoints manually instead of using the
If you are part of the group of maintainers and have correct user permissions
on PyPI, the following steps can be used to release a new version for
Make sure all unit tests are successful.
Tag the current commit on the main branch with a release tag, e.g.,
Push the new tag to the upstream repository, e.g.,
git push upstream v1.2.3
Clean up the
tox -e clean(or
rm -rf dist build) to avoid confusion with old builds and Sphinx docs.
tox -e buildand check that the files in
disthave the correct version (no
.dirtyor git hash) according to the git tag. Also check the sizes of the distributions, if they are too big (e.g., > 500KB), unwanted clutter may have been accidentally included.
tox -e publish -- --repository pypiand check that everything was uploaded to PyPI correctly.