Welcome to xtal2png
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 1.
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 xtal2png
, please have a look
on the issue tracker.
If you don't see anything useful there, please feel free to fire an issue report.
:::{tip} 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.
The discussions page is a great place for topics that don't fit directly into specific future code development plans (i.e. feature requests) or bugs in the software. Issues are easily converted to discussions and vice-versa, so don't worry too much about where to put it if you're not sure. We want to hear from you!
You can help improve xtal2png
docs by making them more readable and coherent, or
by adding missing information and correcting mistakes.
xtal2png
documentation uses Sphinx as its main documentation compiler.
This means that the docs are kept in the same repository as the project code, and
that any documentation update is done in the same way was a code contribution.
We use CommonMark with MyST extensions, meaning most of the documentation files
are Markdown (.md
) files.
:::{tip}
Please notice that the GitHub web interface provides a quick way of
propose changes in xtal2png
'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
the 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 :
tox -e docs
and use Python's built-in web server for a preview in your web browser
(http://localhost:8000
):
python3 -m http.server --directory 'docs/_build/html'
xtal2png
has two main functionalities: encoding crystal structures as PNG
images, and decoding appropriately encoded PNG images back to crystal
structures. Where appropriate, we prefer to use
pymatgen's built-in functionality rather than write
the functionality from scratch. As the main use-case for xtal2png
is
generative modeling of crystal structures using models directly from the
image-processing domain, many of xtal2png
's features are implemented to make
this process better and smoother. On one hand, we're interested in finding an
optimal representation in conjunction with an image generative model (see
hyperparameters
label in issue tracker). In order to know whwat is "better", we also need a
notion of best fit (see
notion-of-best
label). The plan is to expose notions of best fit (i.e. metrics) for crystal
generative modeling via
matbench-genmetrics
,
which is being developed in parallel with but separate from xtal2png
.
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.
Before you start coding, we recommend creating an isolated virtual environment to avoid any problems with your installed Python packages. This can easily be done via either virtualenv:
virtualenv <PATH TO VENV>
source <PATH TO VENV>/bin/activate
or Miniconda:
conda create -n xtal2png python=3 six virtualenv pytest pytest-cov
conda activate xtal2png
-
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 [email protected]:YourLogin/xtal2png.git cd xtal2png
-
You should run:
pip install -U pip setuptools -e .
to be able to import the package under development in the Python REPL.
-
Install pre-commit:
pip install pre-commit pre-commit install
xtal2png
comes with a lot of hooks configured to automatically help the developer to check the code being written.
-
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
AUTHORS.rst
. -
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-commit and 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.
:::{important} 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:
tox
(after having installed tox with
pip install tox
orpipx
).You can also use tox to run several other pre-configured tasks in the repository. Try
tox -av
to see a list of the available checks.
-
If everything works fine, push your local branch to the remote server 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 --tags
should 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-info
folders in thesrc
folder or potentially in the root of your project. -
Sometimes tox misses out when new dependencies are added, especially to
setup.cfg
anddocs/requirements.txt
. If you find any problems with missing dependencies when running a command with tox, try to recreate thetox
environment using the-r
flag. For example, instead of:tox -e docs
Try running:
tox -r -e docs
-
Make sure to have a reliable tox installation that uses the correct Python version (e.g., 3.7+). When in doubt you can run:
tox --version # OR which tox
If you have trouble and are seeing weird errors upon running tox, you can also try to create a dedicated virtual environment with a tox binary freshly installed. For example:
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
--pdb
option (for example by runningtox -- -k <NAME OF THE FALLING TEST> --pdb
). You can also setup breakpoints manually instead of using the--pdb
option.
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
xtal2png
:
- Make sure all unit tests are successful.
- Tag the current commit on the main branch with a release tag, e.g.,
v1.2.3
. - Push the new tag to the upstream repository,
e.g.,
git push upstream v1.2.3
- Verify that the corresponding GitHub action completes successfully
A bot on conda-forge
will recognize the new release on PyPI (typically within a
few hours) and automatically open a pull request (PR) on [xtal2png-feedstock]. See
updating-feedstock for detailed instructions.
Footnotes
-
Even though, these resources focus on open source projects and communities, the general ideas behind collaborating with other developers to collectively create software are general and can be applied to all sorts of environments, including private companies and proprietary code bases. ↩