Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://gitlab.com/opinionated-digital-center/testing-area/python-library-project-generator-gitlab-pipeline-test/-/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitLab issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features¶

Look through the GitLab issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation¶

Generated Python Project GitLab could always use more documentation, whether as part of the official Generated Python Project GitLab docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://gitlab.com/opinionated-digital-center/testing-area/python-library-project-generator-gitlab-pipeline-test/-/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up python-library-project-generator-gitlab-pipeline-test for local development on a Mac.

Prerequisite¶

python 3.6, 3.7 and 3.8 with pyenv
poetry
pre-commit (optional but useful)

Setup (for Mac)¶

Fork the python-library-project-generator-gitlab-pipeline-test repo on GitLab.

Clone your fork locally:

$ git clone https://gitlab.com/your-namespace/python-library-project-generator-gitlab-pipeline-test.git

Assuming you have the prerequisites installed, this is how you set up your fork for local development:
```
$ cd python-library-project-generator-gitlab-pipeline-test/
$ make setup-dev-env-full
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass typing, linting, formatting, unit tests (for all versions of Python) and functional (bdd) tests:
```
$ make tox
```

Note

See the Makefile help for all available targets.

Commit your changes and push your branch to GitLab:

$ git add .
$ git commit -m "[feat|fix|chore|...]: your detailed description of your changes"
$ git push --set-upstream origin name-of-your-bugfix-or-feature

Submit a merge request through the GitLab website.

Merge Request Guidelines¶

Before you submit a merge request, check that it meets these guidelines:

The merge request should include tests.
If the merge request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The merge request should pass on all tests and checks of the pipeline.