Revise documentation of development workflow #53
Merged
Conversation
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
added 2 commits
July 1, 2015 10:00
- in subsection Clone your fork, do not use bullet points for consistency with following subsection - fix a few typos
The use case "Abigail" explains best practices for changing a small piece of documentation.
Use case now advises to: - select option "Create a new branch for this commit and start a pull request" - include flag "[ci skip]" in Pull Request title - add label "documentation"
|
|
||
| She adds a comment to the Pull Request explaining the reason for the change. | ||
| On the GitHub page of NEST she chooses her personal profile as the target and browses to the file she wants to edit. She clicks the button on the top right corner that allows her to edit this file and then fixes the documentation. Once she is done, she writes a meaningful commit message under "Commit changes" at the bottom of the page and selects the option "Create a new branch for this commit and start a pull request". She types in an appropriate branch name and finally clicks "Commit changes". |
There was a problem hiding this comment.
I think you do not mean 'personal profile'. I think what you mean is 'personal fork'?
Something like: "On the GitHub page she navigates to her personal fork of NEST and browses [...]"
There was a problem hiding this comment.
I agree and adapted the text accordingly.
|
The changes look good to me. +1 and merging. Thanks for the contribution. |
jougs
added a commit
that referenced
this pull request
Jul 9, 2015
Revise documentation of development workflow
jougs
pushed a commit
that referenced
this pull request
Apr 6, 2018
jougs
added a commit
that referenced
this pull request
Jun 10, 2021
Update two uses of "stimulating" to "stimulation".
hakonsbm
pushed a commit
to hakonsbm/nest-simulator
that referenced
this pull request
Jan 16, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@tammoippen and @jougs please check whether the use case "Abigail" now describes a reasonable workflow for minor changes to documentation in
masteras well asgh-pages