Add contributing information. #320
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
A link to this file will show up whenever a new Pull Request on Github is created.
| * Each pull request needs to be documented by an issue in the [issue tracker](https://github.com/nest/nest-simulator/issues) explaining the reason for the changes and the solution. The issue is also the place for discussions about the code. | ||
| * New features like SLI or PyNEST functions, neuron or synapse models need to be accompanied by one or more tests written either in SLI or Python. New features for the NEST kernel need a test written in SLI. | ||
| * Each change to the code has to be reflected also in the corresponding examples and documentation. | ||
| * All source code has to be adhering to the Coding Guidelines for [C++](https://nest.github.io/nest-simulator/coding_guidelines_c++) and [SLI](https://nest.github.io/nest-simulator/coding_guidelines_sli) in order to pass the continuous integration system checks. |
|
Great except for some Excessive Capitalisation |
|
👍 from me but maybe @heplesser has some additional feedback |
| @@ -0,0 +1,48 @@ | |||
| # How to contribute | |||
|
|
|||
| The NEST simulator is a scientific tool and as such it is never ready and constantly changing to meet the needs of novel neuroscientific endeavors. Here you find the the most important information on how you can contribute to NEST. This document is an excerpt from our [developer space](https://nest.github.io/nest-simulator/), which provides more detailed information. | |||
There was a problem hiding this comment.
double "the" in "find the the most important"
|
Please consider waiting for answers to my comments before merging. |
| ## Getting started | ||
|
|
||
| * Make sure you have a [GitHub account](https://github.com/signup/free) | ||
| * The development workflow is based purely on pull requests. This [article](https://nest.github.io/nest-simulator/development_workflow) gives information on how to work with git and GitHub, if you are new to it. |
There was a problem hiding this comment.
No comma before "if you are new to it".
|
|
||
| We review each pull request according to our [code review guidelines](https://nest.github.io/nest-simulator/code_review_guidelines): | ||
|
|
||
| * In general, the rule is that each pull request needs an OK from the CI platform and at least two reviewers to be merged. |
There was a problem hiding this comment.
perhaps it's worth mentioning that if it is relevant to an issue then it should say so explicitly (now we have removed the line about requiring an issue number)
|
I think that all comments have been sufficiently addressed. Many thanks for providing this. 👍 and merging. |
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.
A link to this file will show up whenever a new Pull Request on Github is created. Also see Contributing Guidelines for this topic. We could also think about a PR template as suggested here.
Most of the content is copied from the developer space and some structure is inspired from puppet.