Mirrors
/
aredn
mirror of https://github.com/aredn/aredn.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify commit process 

Clarify commit process in the steps to contribute to AREDN using git.
Clarify using github usernames and resources for creating meaningful 
commit descriptions.
This commit is contained in:
Steve AB7PA 2020-09-16 19:20:12 -07:00 committed by GitHub
parent 6b171a63ef
commit 283938c689
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
GitHub-workflow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 164 KiB

After

Width:  |  Height:  |  Size: 130 KiB

13
How to Use GitHub for AREDN.md
View File

@ -7,7 +7,7 @@
To contribute to the AREDN project you first must create your own GitHub account. This is free and easy to do by following these steps:
1. Open your web browser and navigate to the GitHub URL `https://github.com`.
2. Click the `Sign Up` button and enter a username, email, and password. We suggest using your callsign as the username.
2. Click the `Sign Up` button and enter a username, email, and password. We suggest using your callsign as the username which will be indicated below as "myCall". You can, however, create any username you desire. Substitute your actual GitHub username for "myCall" in the examples below.
3. On the GitHub website, click the `Sign In` button and enter your username or email, followed by your github password.
4. You can enter "aredn" into the search bar to find all repositories related to AREDN, or if you want to contribute directly to the AREDN firmware you can type this URL into your web browser: `https://github.com/aredn/aredn_ar71xx`.
@ -15,7 +15,7 @@ To contribute to the AREDN project you first must create your own GitHub account
The process of contributing and tracking changes to AREDN is circular. Code is maintained in the AREDN Master repository on GitHub. To contribute a potential code update, you must first FORK the AREDN master repository to your own GitHub account. You then CLONE your copy of the code from your GitHub repository to your own local computer. Make and test any changes you want to contribute using your local computer's copy of the code.
When you are satisfied with your changes, COMMIT them to your local computer's repository, then PUSH those local changes to your copy of the code on your own GitHub account. Finally, create a PULL REQUEST, which tells the AREDN development team that you would like your changes to be reviewed for inclusion in the AREDN Master repository.
When you are satisfied with your changes, stage and COMMIT them to your local computer's repository, then PUSH those local changes to your copy of the code on your own GitHub account. Finally, create a PULL REQUEST, which tells the AREDN development team that you would like your changes to be reviewed for inclusion in the AREDN Master repository.
![GitHub Workflow](GitHub-workflow.png)
@ -23,7 +23,7 @@ When you are satisfied with your changes, COMMIT them to your local computer's r
1. Login to your own GitHub account and navigate in your browser to `https://github.com/aredn/aredn_ar71xx`
2. Click the `Fork` button on the upper right side of the page. You now have a copy of the AREDN source code on your own GitHub account.
3. Go to your local computer and copy your fork of the AREDN source code: `git clone https://github.com/myCall/aredn_ar71xx`
3. Go to your local computer and copy your fork of the AREDN source code: `git clone https://github.com/[myCall]/aredn_ar71xx`
4. `cd aredn_ar71xx` This directory contains your local copy of the AREDN source code. The following commands will be executed while you are in this directory or its subdirectories.
5. `git remote add aredn https://github.com/aredn/aredn_ar71xx`
@ -47,9 +47,10 @@ Now your local environment knows about both the master code repository and your
7. Resolve any conflicts that need to be merged if warned in the step above.
8. Final build and validation that your changes work on top of the latest changes from all of the AREDN contributors.
5. `Commit` your changes to your local repository, then `Push` the changes to your own GitHub repository.
1. `git commit`
2. `git push origin my-wiz-bang-feature-name`
6. Create a `Pull Request` (PR) to the AREDN master repository by browsing to `github.com/myCall/aredn_ar71xx`, then select the my-wiz-bang-feature-name branch. Click the `New Pull Request` button to generate your Pull Request. Others can now review your code, test it, and give feedback. If feedback is given and you need to make changes, go back to step 3.
1. `git add [any-changed-files]` (stage changes for commit)
2. `git commit` (Be sure to commit your changes with a meaningful commit message. You can refer to the standards used by OpenWRT <https://openwrt.org/submitting-patches> for creating commit descriptions that are easy for others to understand. The key is a commit description that concisely communicates to others what is in the commit.)
3. `git push origin my-wiz-bang-feature-name`
6. Create a `Pull Request` (PR) to the AREDN master repository by browsing to `github.com/[myCall]/aredn_ar71xx`, then select the my-wiz-bang-feature-name branch. Click the `New Pull Request` button to generate your Pull Request. Others can now review your code, test it, and give feedback. If feedback is given and you need to make changes, go back to step 3.
7. Once your changes have been accepted into the AREDN master repository, delete your branch:
1. On your local repository: `git branch -D my-wiz-bang-feature-name`
2. On your forked copy of your GitHub repository: `git push origin --delete my-wiz-bang-feature-name`