Skip to content

📙 [Dev Guide] How to contribute

Jump to bottom
Actionbot edited this page Mar 22, 2024 · 1 revision

Hi there! So you want to contribute to this projects? That's great! Let's go over some basic points to help you get started.

Workflow

This is a mono repo (aka, a lot of things in the same place) for the Core applications of OGrEE: API, CLI and BACK, all developed in Go, as well as APP, developed in Flutter. To organise all this, we follow a feature branching inspired workflow:

  • First, create an issue: this can report a bug, ask for a new functionality, propose discussions or ask questions.

  • If development is needed, create a branch. The name of the brach should be something like {keywork}{#issue}-quick-description, where it starts with one of the following keywords: feature, feat, fix, hotfix, release, chore, break, breaking, docs, followed by the number of the issue and a few words to describe its purpose. For example, if you created na issue to report a bug in the APP's login page, the branch name could be: fix123-app-login-issue.

  • Many new features of even bug fixes may impact more than one application at a time. All the work is done in the same branch. So if your issue impacts the CLI and API at the same time, for example, both should be changed in the same branch. Each commit should also follow a naming pattern: {keyword}({application}) quick description, where the keyword is one of the following: feat, fix, docs, style, refactor, test, chore, ci, break, breaking, hotfix. Example: fix(app) handle login exception.

Be aware: our GitHub workflows will check the branching and commit naming patterns when a PR is created ;)

  • Once all work is done, create a pull request (PR). This will trigger several Github workflows (more about it here) that will test and build your code. If all it's good, it's time for peer review! Another member of the time will check your code, maybe ask some questions or propose some changes. Once approved, the only thing left is to squash and merge. Your code will get to the main branch, closing the issue and triggering more Github workflows to create or aggregate to a release candidate version.

How to checkout a single component

OGrEE-Core is a monorepo hosting 3 differents applications: API, CLI and APP. With git sparse checkout functionality, you can choose which component you want to checkout instead of the whole repo.

mkdir sparse
cd sparse
git init
git remote add -f origin https://github.com/ditrit/OGrEE-Core.git
git sparse-checkout init
# subfolders to checkout
git sparse-checkout set "deploy" "APP"
# branch you wish to checkout
git pull origin main
Clone this wiki locally