mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-06-10 12:51:15 -03:00
contributing: add section about commit history
Adding this info here should hopefully reduce the number of instances where we need to tell new contributors about it in pull requests. Closes #12162
This commit is contained in:
committed by
danielrainer
parent
fb161e9f4d
commit
92c5da1b25
@@ -52,6 +52,23 @@ In short:
|
||||
- Be conservative in what you need (keep to the agreed minimum supported Rust version, limit new dependencies)
|
||||
- Use automated tools to help you (``build_tools/check.sh``)
|
||||
|
||||
Commit History
|
||||
==============
|
||||
|
||||
We use a linear, `recipe-style <https://www.bitsnbites.eu/git-history-work-log-vs-recipe/>`__ history.
|
||||
Every commit should pass our checks.
|
||||
We do not want "fixup" commits in our history.
|
||||
If you notice an issue with a commit in a pull request, or get feedback suggesting changes,
|
||||
you should rewrite the commit history and fix the relevant commits directly,
|
||||
instead of adding new "fixup" commits.
|
||||
When a pull request is ready, we rebase it on top of the current master branch,
|
||||
so don't be shy about rewriting the history of commits which are not on master yet.
|
||||
Rebasing (not merging) your pull request on the latest version of master is also welcome, especially if it resolves conflicts.
|
||||
|
||||
If you're using Git, consider using `jj <https://www.jj-vcs.dev/>`__ to make this easier.
|
||||
|
||||
If a commit should close an issue, add a ``Fixes #<issue-number>`` line at the end of the commit description.
|
||||
|
||||
Contributing completions
|
||||
========================
|
||||
|
||||
|
||||
@@ -39,6 +39,8 @@ function __fish_help_describe -a help_item
|
||||
return
|
||||
case contributing#code-style
|
||||
return
|
||||
case contributing#commit-history
|
||||
return
|
||||
case contributing#configuring-your-editor-for-fish-scripts
|
||||
return
|
||||
case contributing#contributing-completions
|
||||
|
||||
@@ -135,6 +135,7 @@ completions#where-to-put-completions
|
||||
contributing
|
||||
contributing#adding-translations-for-a-new-language
|
||||
contributing#code-style
|
||||
contributing#commit-history
|
||||
contributing#configuring-your-editor-for-fish-scripts
|
||||
contributing#contributing-completions
|
||||
contributing#contributing-documentation
|
||||
|
||||
Reference in New Issue
Block a user