diff options
Diffstat (limited to 'contributing.org')
| -rw-r--r-- | contributing.org | 24 |
1 files changed, 11 insertions, 13 deletions
diff --git a/contributing.org b/contributing.org index b94392e..f50fc59 100644 --- a/contributing.org +++ b/contributing.org @@ -5,24 +5,23 @@ document will help guide you in this endeavour. In case you want to make any non-trivial change to xmobar, it's always best to talk with the community first. Currently the best way to do that -is to [[https://github.com/jaor/xmobar/issues/new][create an issue]] on GitHub. There, you can talk through the +is [[https://codeberg.org/jao/xmobar/issues/new][to create an issue]] on Codeberg. There, you can talk through the problems you are having, as well as the proposed solution. *** Making the change - It's best to create a separate branch in your clone of the [[https://github.com/jaor/xmobar/][xmobar - repo]] and then push this branch to your fork. + It's best to create a separate branch in your clone of the [[https://codeberg.org/jao/xmobar/][xmobar repo]] and + then push this branch to your fork. - If your pull request undergoes several iterations and =master= has - changed in the meantime, you may be asked to rebase on top of it; - in this case please don't merge any branches, but actually rebase! - This is a very nifty feature that =git= offers in order to remain a - clean history. + If your pull request undergoes several iterations and =master= has changed + in the meantime, you may be asked to rebase on top of it; in this case + please don't merge any branches, but actually rebase! This is a very + nifty feature that =git= offers in order to remain a clean history. Give your commits descriptive names! Further, it's also highly - recommended to add a description of /why/ you made a certain change. - The syntax for this is *commit message*, blank line, *more - description*. For example: + recommended to add a description of /why/ you made a certain change. The + syntax for this is *commit message*, blank line, *more description*. For + example: #+begin_src shell Commit Message (max. 50 characters) @@ -35,8 +34,7 @@ problems you are having, as well as the proposed solution. *** Opening a pull request Once you have pushed the branch to your fork, making a pull - request is as easy as visiting that branch; GitHub will then even - prompt you for it! + request is as easy as visiting that branch. Please include the following information in the description of your pull request: |