Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 6.95 KB

CONTRIBUTING.md

File metadata and controls

101 lines (65 loc) · 6.95 KB
Raw

Contributing

Thanks for taking the time to contribute to semantique! Contributions are welcome and greatly appreciated. The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

This project and everyone participating in it is governed by a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the package maintainers.

Contributions can come in many different forms, as we will outline below. You don't even have to know Python to be able to contribute!

Creating issues and discussions

Opening issues and discussions is also a form of contributing. They help us to improve the quality and user-friendliness of the package, as well as to build a community around the package.

Use Issues if

  • You are using the package and something is not working as it should. In that case, use the bug report template. Please first check if its really a bug in semantique, and if there are not already open issues reporting the same bug.
  • You have a request for a new feature. In that case, use the feature request template. Please first check if the feature is not already present, and if there are not already open issues requesting the same feature. A feature request is meant to be very specific. For broader ideas on improving the package, use Discusssions instead.

Use Discussions if

  • You have questions about the package and its functionalities. There might always be someone in the community who is able to help you. Use the Q&A tag for this purpose, and don't forget to mark an answer as accepted if it was helpful.
  • You have broader ideas about improving the package and want to share them, such that they can be discussed with other members of the community. Use the Ideas tag for that purpose. For very specific feature requests, use Issues instead.
  • You have used the package in a cool application and want to share that with other members of the community, such that they can learn from it or give feedback. Use the Show and Tell tag for this purpose.

Solving issues

If you know how to write Python you are welcome to contribute by solving open issues, for example by implementing new features or fixing bugs. Especially those issues labelled with help wanted are desperately begging for contribution. Solving issues does not always involve writing code, you can also help by improving and extending documentation.

In any case, the common code contributing workflow is:

1. Cloning the GitHub repo

Clone this GitHub repo, or alternatively first fork it and then clone your forked version of the repo. After cloning, enter the cloned directory.

git clone [email protected]:ZGIS/semantique.git
cd semantique

2. Creating a local development environment

Always create a new git branch to work in, instead of working in the main branch (if you have forked the repo first this is less important).

git checkout -b my_new_branch

If you work with conda, it can be helpful to create a new conda environment containing all the dependencies of semantique, without disturbing your base environment. To do so, you can make use the environment.yml file contained in this repo.

conda env create -f environment.yml
conda activate semantique

3. Writing code

When writing code we try to follow the Google Python Style Guide. However, we indent code blocks with 2 spaces instead of 4 spaces. Don't forget to actually test your code before commiting.

4. Commiting code to your local branch

When commiting changes with git commit we try to use structured commit messages, adapted from https://www.conventionalcommits.org/. The first line of commit message should have the following format:

<type>: <summary>

The summary should be short (preferably < 50 characters), starting with an upper case, and written in present tense. If the commit references a specific issue, include Refs #<issue number> in the summary. If the issue is a bug report, you may also use Fix #<issue number> such that the issue gets closed automatically.

The type should be one of the defined types listed below. If you feel artistic, you can end the commit message with the emoji belonging to the type |:sunglasses:|.

  • feat: Implementation of a new feature. :gift: |:gift:|
  • fix: A bug fix. :wrench: |:wrench:|
  • style: Changes to code formatting. No change to program logic. :art: |:art:|
  • refactor: Changes to code which do not change behaviour, e.g. renaming variables or splitting functions. :construction: |:construction:|
  • docs: Adding, removing or updating user documentation or to code comments. :books: |:books:|
  • logs: Adding, removing or updating log messages. :sound: |:sound:|
  • test: Adding, removing or updating tests. No changes to user code. :test_tube: |:test_tube:|
  • cicd: Adding, removing or updating CI/CD workflows. No changes to user code. :robot: |:robot:|
  • deps: Adding, removing or updating dependencies. :couple: |:couple:|
  • release: Preparing a release, e.g. updating version numbers. :bookmark |:bookmark:|
  • repo: Changes to the repository that do not involve code/documentation, e.g. adding templates or community files. :package: |:package:|

Example commit messages are:

git commit -m 'feat: Add bar parameter to foo(), Refs #10 :gift:'
git commit -m 'fix: Include type checking in foo(), Fix #12 :wrench:'

5. Pushing your branch to the GitHub repo

Please never push directly to the main branch!

git push origin my_new_branch

6. Creating a pull request

Create a request to merge your changes into the main branch using the Pull Request functionality from GitHub. This should automatically provide you with the pull request template. Add at least one of the package maintainer as reviewer of your pull request, and make sure the automatic checks done by GitHub pass without errors.

Happy coding!