How to contribute to this project

JS2PySecrets welcomes contributions from the community.

Getting started

These instructions are for linux based systems. (Linux, MacOS, BSD, etc.)

Requirements

GitHub to create your own fork
Python3 for the development
NodeJS for interoperability testing
npm to install secrets.js

Using a Docker environment optional

Example of setting up a linux based system.

docker run -ti --entrypoint /bin/bash ubuntu:latest

apt -y update
apt -y install python3 pip git nodejs npm

Setting up your own fork of this repo

With JS2PySecrets in the GitHub interface, click on the Fork button.

Clone your fork of this repo.

git clone git@github.com:YOUR_GIT_USERNAME/JS2PySecrets.git

Enter the directory:
```
cd JS2PySecrets
```

Add the upstream repo:

git remote add upstream https://github.com/poing/JS2PySecrets

Setting up your own virtual environment

Create and activate the virtual environment.

make virtualenvapt -y update
source .venv/bin/activate

Install the project in develop mode

Install packages and the project in develop mode.

1 2	`npm install make install`

Run the tests to ensure everything is working

Run make test to run the tests.

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.

Test your changes

Run make test to run the tests.

Ensure code coverage report shows 100% coverage, add tests to your PR.

Build the docs locally

Run make docs to build the docs.

Ensure your new changes are documented.

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 github interface, click on Pull Request button.

Wait CI to run and one of the developers will review your PR.

Makefile utilities

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

❯ make
Usage: make <target>

Targets:
help:             ## Show the help.
install:          ## Install the project in dev mode.
fmt:              ## Format code using black & isort.
lint:             ## Run pep8, black, mypy linters.
test: lint        ## Run tests and generate coverage report.
watch:            ## Run tests on every change.
clean:            ## Clean unused files.
virtualenv:       ## Create a virtual environment.
release:          ## Create a new tag for release.
docs:             ## Build the documentation.
switch-to-poetry: ## Switch to poetry package manager.
init:             ## Initialize the project based on an application template.

Currently does not work.

Issue with the template used for this project!

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, github actions will automatically create a new release on github and trigger a release on PyPI.

For this to work you need to setup a secret called PIPY_API_TOKEN on the project settings>secrets, this token can be generated on pypi.org.

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.

the make release will ask you the version number to create the tag, ex: type 0.1.1 when you are asked.

Caution

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