Add contributing information. #320

Merged
merged 4 commits into from Apr 26, 2016

Conversation

Projects
None yet
4 participants
@tammoippen
Contributor

tammoippen commented Apr 25, 2016

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.

Add contributing information.
A link to this file will show up whenever a new Pull Request on Github is created.
CONTRIBUTING.md
+* 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.

This comment has been minimized.

@abigailm

abigailm Apr 25, 2016

Contributor

coding guidelines

@abigailm

abigailm Apr 25, 2016

Contributor

coding guidelines

CONTRIBUTING.md
+* 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.
+* All Commits should be coherent and contain only changes that belong together.

This comment has been minimized.

@abigailm

abigailm Apr 25, 2016

Contributor

commits

@abigailm

abigailm Apr 25, 2016

Contributor

commits

CONTRIBUTING.md
+* Sign the [Contributor License Agreement](https://nest.github.io/nest-simulator/#contributor-license-agreement).
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the [NEST repository](https://github.com/nest/nest-simulator).
+* The core team looks at Pull Requests on a regular basis and posts feedback.

This comment has been minimized.

@abigailm

abigailm Apr 25, 2016

Contributor

pull requests

@abigailm

abigailm Apr 25, 2016

Contributor

pull requests

@abigailm

This comment has been minimized.

Show comment
Hide comment
@abigailm

abigailm Apr 25, 2016

Contributor

Great except for some Excessive Capitalisation

Contributor

abigailm commented Apr 25, 2016

Great except for some Excessive Capitalisation

@abigailm

This comment has been minimized.

Show comment
Hide comment
@abigailm

abigailm Apr 25, 2016

Contributor

👍 from me but maybe @heplesser has some additional feedback

Contributor

abigailm commented Apr 25, 2016

👍 from me but maybe @heplesser has some additional feedback

CONTRIBUTING.md
@@ -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.

This comment has been minimized.

@jougs

jougs Apr 25, 2016

Contributor

double "the" in "find the the most important"

@jougs

jougs Apr 25, 2016

Contributor

double "the" in "find the the most important"

CONTRIBUTING.md
+
+## Making Changes
+
+* Create a topic branch from NEST master in your fork. Please avoid working directly on the `master` branch.

This comment has been minimized.

@jougs

jougs Apr 25, 2016

Contributor

Add a reference to #31 to explain why. Or even better integrate that information into the developer space!

@jougs

jougs Apr 25, 2016

Contributor

Add a reference to #31 to explain why. Or even better integrate that information into the developer space!

CONTRIBUTING.md
+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.
+* For changes labeled “not code” or “minor” (e.g. changes in documentation, fixes for typos, etc.), the release manager can waive the need for code review and just accept the OK from Travis in order to merge the request.

This comment has been minimized.

@jougs

jougs Apr 25, 2016

Contributor

Shouldn't these be normal quotes (around "not code" and "minor"? They look like some kind of fancy unicode quotes to me that might cause trouble on some systems

@jougs

jougs Apr 25, 2016

Contributor

Shouldn't these be normal quotes (around "not code" and "minor"? They look like some kind of fancy unicode quotes to me that might cause trouble on some systems

CONTRIBUTING.md
+
+* In general, the rule is that each pull request needs an OK from the CI platform and at least two reviewers to be merged.
+* For changes labeled “not code” or “minor” (e.g. changes in documentation, fixes for typos, etc.), the release manager can waive the need for code review and just accept the OK from Travis in order to merge the request.
+* 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.

This comment has been minimized.

@jougs

jougs Apr 25, 2016

Contributor

I think we can remove this sentence both from here and from the developer space. Almost no one is adhering to this and I personally have the feeling that this causes more work and separation of information than it helps to keep the discussion structured (which was the original aim of this requirement).

@jougs

jougs Apr 25, 2016

Contributor

I think we can remove this sentence both from here and from the developer space. Almost no one is adhering to this and I personally have the feeling that this causes more work and separation of information than it helps to keep the discussion structured (which was the original aim of this requirement).

This comment has been minimized.

@heplesser

heplesser Apr 25, 2016

Contributor

I agree!

@heplesser

heplesser Apr 25, 2016

Contributor

I agree!

CONTRIBUTING.md
+* 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.
+* All commits should be coherent and contain only changes that belong together.

This comment has been minimized.

@jougs

jougs Apr 25, 2016

Contributor

Please add a sentence about the adherence to PEP-8 for Python files here and in the developer space.

@jougs

jougs Apr 25, 2016

Contributor

Please add a sentence about the adherence to PEP-8 for Python files here and in the developer space.

@jougs

This comment has been minimized.

Show comment
Hide comment
@jougs

jougs Apr 25, 2016

Contributor

Please consider waiting for answers to my comments before merging.

Contributor

jougs commented Apr 25, 2016

Please consider waiting for answers to my comments before merging.

CONTRIBUTING.md
+## 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.

This comment has been minimized.

@heplesser

heplesser Apr 25, 2016

Contributor

No comma before "if you are new to it".

@heplesser

heplesser Apr 25, 2016

Contributor

No comma before "if you are new to it".

CONTRIBUTING.md
+* 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.

This comment has been minimized.

@heplesser

heplesser Apr 25, 2016

Contributor

"has to conform" instead of "has to be adhering"

@heplesser

heplesser Apr 25, 2016

Contributor

"has to conform" instead of "has to be adhering"

+
+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.

This comment has been minimized.

@abigailm

abigailm Apr 26, 2016

Contributor

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)

@abigailm

abigailm Apr 26, 2016

Contributor

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)

@tammoippen

This comment has been minimized.

Show comment
Hide comment
@tammoippen

tammoippen Apr 26, 2016

Contributor

@abigailm Please see 795134b.

Contributor

tammoippen commented Apr 26, 2016

@abigailm Please see 795134b.

@jougs

This comment has been minimized.

Show comment
Hide comment
@jougs

jougs Apr 26, 2016

Contributor

I think that all comments have been sufficiently addressed. Many thanks for providing this. 👍 and merging.

Contributor

jougs commented Apr 26, 2016

I think that all comments have been sufficiently addressed. Many thanks for providing this. 👍 and merging.

@jougs jougs merged commit c03583e into nest:master Apr 26, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@tammoippen tammoippen deleted the tammoippen:templates branch May 18, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment