diff options
| author | Noah Spahn <noah.de@gmail.com> | 2020-10-22 12:07:04 -0700 |
|---|---|---|
| committer | Noah Spahn <noah.de@gmail.com> | 2020-10-22 12:07:04 -0700 |
| commit | 8295342ac1b4ba0a98d6ce36cba2713903f34bd1 (patch) | |
| tree | 190a74e63933701321fa0c9b38cfcc5b2c07fcaa /docs/contributing | |
| parent | b7b3b7a4dbc19dc6d95dfd4f7f9f90eba65de016 (diff) | |
| download | vyos-documentation-8295342ac1b4ba0a98d6ce36cba2713903f34bd1.tar.gz vyos-documentation-8295342ac1b4ba0a98d6ce36cba2713903f34bd1.zip | |
revisions to the forking instructions
main changes include a consistent reference to the branch name
installing requirements before building locally
an alternate method for adding a commit message
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/documentation.rst | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 8102e9a9..2b2d3ba7 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -35,12 +35,12 @@ access to the official codebase. * Fork this project on GitHub https://github.com/vyos/vyos-documentation/fork -* Clone fork to local machine +* Clone fork to local machine, then change to that directory``$ cd vyos-documentation`` -* Change to your new local directory ``$ cd vyos-documentation`` +* Install the requirements ``$ pip install -r requirements.txt`` (or something similar) * Create new branch for your work, use a descriptive name of your work: - ``$ git checkout -b fix-vxlan-typo`` + ``$ git checkout -b <branch-name>`` * Make all your changes - please keep our commit rules in mind (:ref:`prepare_commit`). This mainly applies to proper commit messages @@ -61,11 +61,12 @@ access to the official codebase. unstaged files ``$ git add .``. All files added to the Git index will be part of you following Git commit. -* Commit your changes ``$ git commit -v`` - your configured editor will now ne - launched where you can type in a commit message. Again please make yourself - comfortable with out rules (:ref:`prepare_commit`). +* Commit your changes with the message, ``$ git commit -m "<commit message>"`` + or use ``$ git commit -v`` to have your configured editor launched. You can + type in a commit message. Again please make yourself comfortable with out + rules (:ref:`prepare_commit`). -* Push your commits to your GitHub project: ``$ git push -u origin foo-branch`` +* Push commits to your GitHub project: ``$ git push -u origin <branch-name>`` * Submit pull-request. In GitHub visit the main repository and you should see a banner suggesting to make a pull request. Fill out the form and |