@@ -24,15 +24,11 @@ Most of our discussions take place on [issues][link_issues].
[git ][link_git] is a really useful tool for version control.
[GitHub ][link_github] sits on top of git and supports collaborative and distributed working.
If you're not yet familiar with `git` , there are lots of great resources to help you *git* started!
If you are not yet familiar with `git` , there are lots of great resources to help you *git* started!
Some of our favorites include the [git Handbook ][link_handbook] and
the [Software Carpentry introduction to git ][link_swc_intro].
On GitHub, you will use [Markdown ][markdown] to chat in issues and pull requests.
You can think of Markdown as a few little symbols around your text that will allow GitHub
to render the text with a little bit of formatting.
For example you could write words as bold (`**bold**` ), or in italics (`*italics*` ),
or as a [link ][rick_roll] (`[link](https://https://youtu.be/dQw4w9WgXcQ)` ) to another webpage.
GitHub has a really helpful page for getting started with
[writing and formatting Markdown on GitHub ][writing_formatting_github].
@@ -59,9 +55,9 @@ but those accepted fastest will follow a workflow similar to the following:
**1. Comment on an existing issue or open a new issue referencing your addition.**
This allows other members of the ``geomstats`` development team to confirm that you aren't
overlapping with work that's currently underway and that everyone is on the same page
with the goal of the work you're going to carry out.
This allows other members of the ``geomstats`` development team to confirm that you are not
overlapping with work that is currently underway and that everyone is on the same page
with the goal of the work you are going to carry out.
[This blog ][link_pushpullblog] is a nice explanation of why putting this work in up front
is so useful to everyone involved.
@@ -73,7 +69,7 @@ Changes here will not effect anyone else's work, so it is a safe space to explor
Make sure to [keep your fork up to date ][link_updateupstreamwiki] with the master repository.
**3. Make the changes you've discussed, following the [geomstats coding style guide](#geomstats-coding-style-guide).**
**3. Make the changes you have discussed, following the [geomstats coding style guide](#geomstats-coding-style-guide).**
- Create your feature branch (`git checkout -b feature/fooBar` )
- Commit your changes (`git commit -am 'Add some fooBar'` )
@@ -82,10 +78,20 @@ Make sure to [keep your fork up to date][link_updateupstreamwiki] with the maste
Try to keep the changes focused.
If you feel tempted to "branch out" then please make a [new branch ][link_branches].
If you are adding a new feature, don't forget to add the corresponding [unit tests ][link_unit_tests].
**4. Add the corresponding unit tests.**
If you are adding a new feature, do not forget to add the corresponding [unit tests ][link_unit_tests].
As ``geomstats`` enables numpy and tensorflow, your unit tests should run on these two backends.
**4. Submit a [pull request][link_pullrequest].**
**5. Ensure Geomstats Coding Style Guide.**
Ensure that your code is compliant with [PEP8 ][link_pep8],
the coding style guide for python.
Use [flake8 ][link_flake8] or [yapf ][link_yapf] to automatically enforces this style.
**6. Submit a [pull request][link_pullrequest].**
A member of the development team will review your changes to confirm
that they can be merged into the main code base.
@@ -99,18 +105,12 @@ Use the Github labels to label your pull request:
* ``refactoring`` : refactoring existing code
* ``continuous integration`` : updates to continous integration infrastructure
## Geomstats Coding Style Guide
Ensure that your code is compliant with [PEP8 ][link_pep8],
the coding style guide for python, as enforced by [flake8 ][link_flake8].
Flake8 is a tool, called a [linter ][link_linters] that automatically enforces this style.
## Recognizing Contributions
We welcome and recognize all contributions from documentation to testing to code development.
You can see a list of current contributors in our [README.md ][link_readme].
If you are new to the project, don't forget to add your name and affiliation there!
If you are new to the project, do not forget to add your name and affiliation there!
## Thank You!
@@ -143,5 +143,6 @@ If you are new to the project, don't forget to add your name and affiliation the
[link_pep8 ]: https://www.python.org/dev/peps/pep-0008/
[link_linters ]: https://en.wikipedia.org/wiki/Lint_(software)
[link_flake8 ]: http://flake8.pycqa.org/en/latest/
[link_yapf ]: https://github.com/google/yapf
[link_readme ]: https://github.com/geomstats/geomstats/blob/master/README.md
[link_fmriprep ]: https://github.com/poldracklab/fmriprep/
0 comments on commit
ce31656