contributing.md

Contributing

We highly appreciate your contributions to the project ❤️

Main flow

Step 1 — get code

git clone [email protected]:ton-org/blueprint.git
cd blueprint
git checkout -b name-of-your-feature origin/develop

Step 2 — write code

Write the code for your change, test it locally, then commit

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 a fork

Go here to make a fork, then setup your remote:

git remote add self url_of_your_fork

Step 4 — make a pull request

Push:

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

Then create a pull request from the pull requests page or directly:

https://github.com/ton-org/blueprint/pull/new/name-of-your-feature

(note the name of your branch in the URL)

Step 5 — update your branch from main

This step may be necessary in case the main/develop branch has changed since you created your branch

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 pushing to your own branch

During the rebase, there may be conflicts, they need to be resolved; once the conflicts are resolved, you can 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-your-feature

More details can be found in the tutorial: git rebase

All set 🎉

Thanks for your time and code!