CONTRIBUTING

When contributing to this repository, please first discuss the change you wish to make via issues.

Please note if you are working on a certain issue then make sure to stay active with development.

Git Commit, Branch, and PR Naming Conventions

When you are working with git, please be sure to follow the conventions below on your pull requests, branches, and commits:

PR: [#ISSUE ID] Title of the PR
Branch: [ISSUE ID]-title-of-the-pr (shorter)
Commit: [[ISSUE ID]] [ACTION]: what was done

Examples:

PR: #2 Add Docker container for Postgres
Branch: 2-add-container-postgres
Commit: [2] feat: add docker container for postgres

If you want to work on a new feature, follow these steps.

Fork the repository
Clone your fork
Checkout a new branch
Do your work
Commit
Push your branch to your fork
Go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN

You should pull in the changes that we add in daily, preferably before you checkout a new branch to do new work.

git checkout main

git pull upstream main

Before submitting a Pull Request, you should

Ensure your code is safe and aligns with the codebase technologies of the project, and verify that it builds successfully.