Dev: Contributing
Hi! Thanks for wanting to contribute!
Please drop by to discuss your plans in our Discord, or find an issue from our queue and ping it.
To contribute, we suggest a variant of fork and and branch.
We work in branches on our own forks and then send PRs to this repo on the [main] branch. This repo's main branch is referred to as "upstream/main" when you're working from your fork. If you forked on GitHub, this naming should be done automatically. Otherwise, you'll need to setup your clone to track the main repo as "upstream".
When creating your new feature branch in your fork, it's important to create your branch from the most up-to-date version from upstream/main. In your client workspace, this is accomplished with:
git checkout -b <name of your feature> upstream/main
You can then compare the local log with this repo's changes to verify you're up-to-date.
For example, this was how things looked one sunny spring day:
# Compare to https://github.com/bldrs-ai/Share/commits/main
> git log
commit 770465e8922be1c0e27460da6cd1fb4b7494b0c6 (HEAD -> upgrade, upstream/main)
Author: Pablo Mayrgundter <[email protected]>
Date: Tue May 24 05:27:44 2022 -0500
...
And here on GitHub
