Add conventions to readme #40

bernie commented 2022年12月09日 19:55:19 +01:00 (Migrated from gitea.pep.foundation)

Git Instructions

• All changes go via branch and Pull Request

• No longer direct commits to master

To create a new branch and work on it:

1. $ git checkout master

2. $ git pull

3. $ git checkout -b <name-of-new-branch>

4. Update files

5. $ git commit -m "<commit message>"

6. $ git push --set-upstream <name-of-new-branch>

   • This provides you a URL to create a pull request

7. Create that pull request, but set it to WIP (Work In progress)

8. Continue to commit on the new branch and push.

   1. Update files

   2. $ git commit -m "<commit message>"

   3. $ git push

Basic helper functions:

• To verify on which branch you are you may use

  • $ git branch

  and/or

  • $ git status

• In case you end up on another branch use

  • $ git checkout <name-of-new-branch>

• If there was a change on master, you can rebase (synchronize) your branch with the changes as follows (on your branch):

  • $ git pull --rebase origin master

  or alternatively (step-by-step):

  1. $ git checkout master

  2. $ git pull

  3. $ git checkout ;

  4. $ git rebase master

If there are conflicts during rebase, you neeed to resolve those. You may use, e.g.

• $ git rebase -i

---

New style for linefeeds in .mkd docucuments

• One line per sentence

  • Reason: changes are better visible in diffs

• So far only pep-keyreset, pep-general and pep-email has been converted completely to the new style

  • Whenever you touch something, please use the new style for linefeeds for inserts or around the changes to gradually convert the documents to new style

**Git Instructions** * All changes go via branch and Pull Request * No longer direct commits to master To create a new branch and work on it: 1. $ git checkout master 2. $ git pull 3. $ git checkout -b \<name-of-new-branch\> 4. Update files 5. $ git commit -m "\<commit message\>" 6. $ git push --set-upstream \<name-of-new-branch\> * This provides you a URL to create a pull request 7. Create that pull request, but set it to WIP (Work In progress) 8. Continue to commit on the new branch and push. 1. Update files 2. $ git commit -m "\<commit message\>" 3. $ git push Basic helper functions: * To verify on which branch you are you may use * $ git branch and/or * $ git status * In case you end up on another branch use * $ git checkout \<name-of-new-branch\> * If there was a change on master, you can rebase (synchronize) your branch with the changes as follows (on your branch): * $ git pull --rebase origin master or alternatively (step-by-step): 1. $ git checkout master 2. $ git pull 3. $ git checkout <your branch>; 4. $ git rebase master If there are conflicts during rebase, you neeed to resolve those. You may use, e.g. * $ git rebase -i --- **New style for linefeeds in .mkd docucuments** * One line per sentence * Reason: changes are better visible in diffs * So far only pep-keyreset, pep-general and pep-email has been converted completely to the new style * Whenever you touch something, please use the new style for linefeeds for inserts or around the changes to gradually convert the documents to new style