Before reporting a bug, try to search for a similar problem in the Issues section on GitHub. Clear the search bar to include closed issues in the search and type your phrase.
If you have not found a relevant issue, you can report the bug in the Issues section. When you click on New issue, two templates will be displayed — please pick Bug Report. Carefully fill out the template and submit the issue.
If you have an idea for improvement, you can submit your proposal in the Issues section on GitHub. When you click on New issue, two templates will be displayed — please pick Feature Request. Carefully fill out the template and submit the issue.
Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub
In order to begin working on the project, please complete these tasks:
-
Clone our repository and enter the project's root directory:
git clone https://github.com/AngryMaciek/angry-moran-simulator.git cd angry-moran-simulator -
Install Conda (package management system and environment management). You can find the installation instructions in Anaconda page or in Miniconda page.
-
Install Mamba package manager on top, according to these instructions.
-
(Optional) This tools is (also) packaged as a conda package. If you plan to build it during development please install conda-build or boa together with conda-verify. These should be installed in
baseenvironment too, otherwise bad things will happen. -
Setup a Conda environment to install all needed dependencies:
mamba env create
-
In order to activate new created Conda environment type:
conda activate moranpycess-dev
If you have no experience with Conda environments, read about them under this address.
-
Install our pre-commit hooks into your local version of the repository:
pre-commit install
-
To install moranpycess in your development environment please run:
make install # Linux, macOS
pip install . # WindowsIf you want to uninstall it use:
make uninstall # Linux, macOS
pip uninstall moranpycess --yes # Windows(╯°□°)╯︵ ┻━┻
If that above is you, feeling like flipping a table just by the sheer looks of all the instructions above, do not despair! You still can contribute to our codebase from the cloud! We set up an ephemeral Gitpod environment for all the developers who prefer coding from a remote server.
Just click on this cool button below:
See more information on how to start up a Gitpod environment dedicated to a specific remote branch here, specific issue here and a specific pull request here.
However, please remember that such luxury is limitted:
Gitpod offers a free plan for new users which includes 50 hours of standard workspace usage. If you need more hours, you can upgrade to one of the paid plans in your personal settings.
You can read about git branching under this address. The branch names should follow the convention specified below:
<type>/<issue id>/<short description>
where
- type is one of the Conventional Commits' types, i.e.
feat,ci,docs,fix,refactor,test,chore, etc. - issue id is the id of the issue which will be fixed by this PR.
- short description is ~25 characters long at max and is hyphenated.
Examples:
chore/6/gitignore
ci/20/testing-and-code-coverage
ci/21/flake8-action
ci/46/docstring-linting
docs/22/contributing-instructions
feat/3/license
feat/4/github-templates
feat/40/version-flag
feat/7/code-of-conduct
refactor/8/initial-project-structure
Make sure the following checks pass with no errors:
make formatmake lintmake testmake installmake docsmake build
A pull request can only be merged after it completed all of the checks performed by CI. After a manual review by one of the maintainers, it can be merged into master. The merge commit should follow the rules outlined in Conventional Commits.