docs: add contributing, git, and styleguide docs #56
Conversation
0xdeafbeef
force-pushed
the
0xdeafbeef/push-yltnpnxmvnpm
branch
3 times, most recently
from
e63565d to
2d21083
Compare
docs/contributing.md
Outdated
|
|
||
| - **Fork the Repository:** Fork the repository or create a new branch in the | ||
| repository if you have write access. Prefix the branch name with your | ||
| username. |
There was a problem hiding this comment.
is it really necessary to prefix branch with username?
There was a problem hiding this comment.
For now, it's too much. Later, it will be easier to gc dead branches etc
| - **Fork the Repository:** Fork the repository or create a new branch in the | ||
| repository if you have write access. Prefix the branch name with your | ||
| username. | ||
| - **Commit Structure:** We review each commit separately, and we do not use the |
There was a problem hiding this comment.
nice idea, but not applicable for current development stage
There was a problem hiding this comment.
If you're at a stage where structuring commits is not feasible, you can always squash them into a single commit before submitting your PR. It will make the life of a reviewer a bit easier
There was a problem hiding this comment.
Let's be honest, we do not review every single commit. We review the whole code
|
|
||
| ## No-Merge Policy | ||
|
|
||
| The broxus/tycho repo uses what is known as a "rebase workflow." This means |
There was a problem hiding this comment.
We discussed previously merges are fine. Did things change?
There was a problem hiding this comment.
- create branch
- make changes
- if master or upstream branch was updated - rebase on top if it. Don't merge it
- after review pr will be merged
intial state:
A - B - C (master)
\
D - E (feature)
Rebase onto master:
A - B - C - D' - E' (master, feature)
Merge master into branch:
A - B - C (master)
\ \
D - E - M (feature)
2d21083 to
a9332fc
Compare
0xdeafbeef
force-pushed
the
0xdeafbeef/push-yltnpnxmvnpm
branch
from
a9332fc to
a1af099
Compare
No description provided.