How to develop on this project

project_name welcomes contributions from the community.

This instructions are for linux base systems. (Linux, MacOS, BSD, etc.)

Setting up your own fork of this repo.

On gitea interface click on Fork button.
Clone your fork of this repo. git clone git@git.disi.dev:YOUR_GIT_USERNAME/project_urlname.git
Enter the directory cd project_urlname
Add upstream repo git remote add upstream https://git.disi.dev/author_name/project_urlname
initialize repository for use make setup

Install the project in develop mode

Run make install to install the project in develop mode.

Create a new branch to work on your contribution

Run git checkout -b my_contribution

Make your changes

Edit the files using your preferred editor. (we recommend VIM or VSCode)

Format the code

Run make fmt to format the code.

Run the linter

Run make lint to run the linter.

Commit your changes

This project uses conventional git commit messages.

Example: fix(package): update setup.py arguments 🎉 (emojis are fine too)

Push your changes to your fork

Run git push origin my_contribution

Submit a pull request

On gitea interface, click on Pull Request button.

Makefile utilities

This project comes with a Makefile that contains a number of useful utility.

❯ make
Usage: make <target>

Targets:
help:             ## Show the help.
setup:            ## Perform initial repository setup after cloning.
fmt:              ## Format code.
lint:             ## Run linters.
clean:            ## Clean unused files.
virtualenv:       ## Create a virtual environment.
release:          ## Create a new tag for release.
init:             ## Initialize the project based on an application template.

Making a new release

This project uses semantic versioning and tags releases with X.Y.Z Every time a new tag is created and pushed to the remote repo, gitea actions will automatically create a new release on gitea.

To trigger a new release all you need to do is.

If you have changes to add to the repo
- Make your changes following the steps described above.
- Commit your changes following the conventional git commit messages.
Run the tests to ensure everything is working.
Run make release to create a new tag and push it to the remote repo.

Caution

: The make release will change local changelog files and commit all the unstaged changes you have.

2.5 KiB Raw Blame History Unescape Escape