CRXN
/
docs
mirror of https://codeberg.org/CRXN/docs.git
1
0
Fork 0
Code Releases Activity

add tutorial how to squash commits in git 

Signed-off-by: Marek Küthe <m.k@mk16.de>
This commit is contained in:
Marek Küthe 2023-01-01 19:38:25 +01:00
parent 4ab4dd8c4a
commit e87c39405f
No known key found for this signature in database
GPG Key ID: 7E869146699108C7
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/entitydb/format-rules.md
View File

@ -30,5 +30,24 @@ The edb repository currently contains two different scripts:
| `test.sh` | Tests the JSON files for validity |
| `build_maxlen_filter.sh` | Builds a bird-compatible filter list |
## Do I need to sqash my commits before setting a PR?
Yes and No. Changes to files should be traceable. Therefore, a commit is recommended for every change. However, we also want to avoid more than 30 commits for one file in one PR. Therefore, if there are still mistakes in the initial registration, it would be nice to keep the number of commits within limits.
With the following commands you can squash two commits to one:
```
git rebase -i HEAD~2
```
Replace the second `pick` with `s` or `squash`. Save the file and exit.
Enter your new commit message. Save the file and exit.
Sign the commit with the following command:
```
git commit --amend -s -S
```
After that you can upload the changes. If the Git server rejects the changes, you can use the following command:
```
git push -f
```
## License
The edb is available under the AGPL v3 license. More information is available in the `LICENSE.md` in the repository of the edb.