contributing.md

Contributing

This agreement is for collaboration, it may not be detailed enough, if it is not clear how to do what you want, this is a normal situation, just ask your colleagues.

Main flow

Step 1 — get code

git clone git@github.com:layer2state/radar.git
cd elemgame.app
git checkout -b name-of-feature origin/main

Step 2 — write code

Coding and testing local see README.md Development

Git history: work log vs recipe https://www.bitsnbites.eu/git-history-work-log-vs-recipe/

Use Conventional Commits

git commit --message "feat: paypal payment for different users"

or

git commit --message "fix: hide password display when searching for a user"

Step 3 — make fork

Follow by link for make fork: https://github.com/layer2state/radar/fork

Setup your remote

git remote add self url_your_fork

Step 4 — make pull requests

Push and create pull requests

git push --set-upstream self name-of-feature

Follow by link:

https://github.com/layer2state/radar/pull/new/name-of-feature

Step 5 — update branch from main

This step may be necessary in case your colleagues suggest additional changes after reviewing the code.

Note

A tidy, linear Git history https://www.bitsnbites.eu/a-tidy-linear-git-history/

Get the latest upstream changes and update the working branch:

git fetch --prune origin
git rebase --autostash --ignore-date origin/main

Warning

Please note that you get the current state of the main branch from the origin remote for doing push to self

During the rebase, there may be conflicts, they need to be resolved and after the decision to continue the rebase:

git rebase --continue

Upload the updated working branch to the repository, given that we changed the history, this should be done with the force option:

git push --force --set-upstream self name-of-feature

More details can be found in the tutorial: git rebase.