-
Notifications
You must be signed in to change notification settings - Fork 168
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
style: Also format markdown files with Prettier (#1177)
Co-authored-by: Edouard Choinière <[email protected]>
- Loading branch information
Showing
16 changed files
with
575 additions
and
564 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,36 +23,36 @@ GRASS GIS developer mailing list. | |
|
||
### First time setup | ||
|
||
* Create an account on GitHub. | ||
* Install Git on your computer. | ||
* Set up Git with your name and email. | ||
* Fork the repository. | ||
* Clone your fork (use SSH or HTTPS URL): | ||
- Create an account on GitHub. | ||
- Install Git on your computer. | ||
- Set up Git with your name and email. | ||
- Fork the repository. | ||
- Clone your fork (use SSH or HTTPS URL): | ||
|
||
```bash | ||
git clone [email protected]:your_GH_account/grass-addons.git | ||
``` | ||
|
||
* Enter the directory | ||
- Enter the directory | ||
|
||
```bash | ||
cd grass-addons/ | ||
``` | ||
|
||
* Add main GRASS GIS Addons repository as "upstream" (use HTTPS URL): | ||
- Add main GRASS GIS Addons repository as "upstream" (use HTTPS URL): | ||
|
||
```bash | ||
git remote add upstream https://github.com/OSGeo/grass-addons | ||
``` | ||
|
||
* Your remotes now should be "origin" which is your fork and "upstream" which | ||
- Your remotes now should be "origin" which is your fork and "upstream" which | ||
is this main GRASS GIS Addons repository. You can confirm that using: | ||
|
||
```bash | ||
git remote -v | ||
``` | ||
|
||
* You should see something like: | ||
- You should see something like: | ||
|
||
```text | ||
origin [email protected]:your_GH_account/grass-addons.git (fetch) | ||
|
@@ -65,19 +65,19 @@ It is important that "origin" points to your fork. | |
|
||
### Update before creating a feature branch | ||
|
||
* Download updates from all branches from the _upstream_ remote: | ||
- Download updates from all branches from the _upstream_ remote: | ||
|
||
```bash | ||
git fetch upstream | ||
``` | ||
|
||
* Make sure your are starting with the branch for the latest version, i.e., _grass8_: | ||
- Make sure your are starting with the branch for the latest version, i.e., _grass8_: | ||
|
||
```bash | ||
git switch grass8 | ||
``` | ||
|
||
* Update your local branch to match the one in the upstream repository: | ||
- Update your local branch to match the one in the upstream repository: | ||
|
||
```bash | ||
git rebase upstream/grass8 | ||
|
@@ -92,13 +92,13 @@ then move your uncommitted local changes to "stash" using: | |
git stash | ||
``` | ||
|
||
* Now you can rebase: | ||
- Now you can rebase: | ||
|
||
```bash | ||
git rebase upstream/grass8 | ||
``` | ||
|
||
* Apply your local changes on top of the updated code: | ||
- Apply your local changes on top of the updated code: | ||
|
||
```bash | ||
git stash pop | ||
|
@@ -109,7 +109,7 @@ git stash pop | |
Now you have updated your local branch, you can create a feature branch | ||
based on it. | ||
|
||
* Create a new feature branch and switch to it: | ||
- Create a new feature branch and switch to it: | ||
|
||
```bash | ||
git switch -c new-feature | ||
|
@@ -123,22 +123,22 @@ general [GRASS GIS Programming Style Guide](https://github.com/OSGeo/grass/blob/ | |
|
||
### Committing | ||
|
||
* Add files to the commit (changed ones or new ones): | ||
- Add files to the commit (changed ones or new ones): | ||
|
||
```bash | ||
git add file1 | ||
git add file2 | ||
``` | ||
|
||
* Commit the change (first word is the module name): | ||
- Commit the change (first word is the module name): | ||
|
||
```bash | ||
git commit -m "module: added a new feature" | ||
``` | ||
|
||
### Pushing changes to GitHub | ||
|
||
* Push your local feature branch to your fork: | ||
- Push your local feature branch to your fork: | ||
|
||
```bash | ||
git push origin new-feature | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.