diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8c8cabad21..d36f61b080 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,8 +55,9 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting Oscar Esteban at -or Chris Markiewicz at , two members of the project team. +reported by contacting Oscar Esteban at <oesteban@stanford.edu> +or Chris Markiewicz at <markiewicz@stanford.edu>, two members of the project +team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. @@ -68,10 +69,11 @@ members of the project's leadership. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version +1.4, available at + [homepage]: https://www.contributor-covenant.org For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b7b92f805..789164f04a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,7 +9,8 @@ These guidelines are designed to make it as easy as possible to get involved. If you have any questions that aren't discussed below, please let us know by opening an [issue][link_issues]! -Before you start you'll need to set up a free [GitHub][link_github] account and sign in. +Before you start you'll need to set up a free [GitHub][link_github] account and +sign in. Here are some [instructions][link_signupinstructions]. Already know what you're looking for in this guide? Jump to the following sections: @@ -22,7 +23,6 @@ Already know what you're looking for in this guide? Jump to the following sectio * [Licensing](#licensing) * [Recognizing contributors](#recognizing-contributions) - ## Joining the conversation `sMRIPrep` is maintained by a growing group of enthusiastic developers— @@ -34,64 +34,70 @@ a community platform for discussing neuroimaging. We actively monitor both spaces and look forward to hearing from you in either venue! - ## Contributing through GitHub [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. +[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're 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'll 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 +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. +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]. - ## Understanding issues Every project on GitHub uses [issues][link_issues] slightly differently. The following outlines how the ``sMRIPrep`` developers think about these tools. -* **Issues** are individual pieces of work that need to be completed to move the project forwards. +**Issues** are individual pieces of work that need to be completed to move the +project forwards. A general guideline: if you find yourself tempted to write a great big issue that -is difficult to describe as one unit of work, please consider splitting it into two or more issues. - - Issues are assigned [labels](#issue-labels) which explain how they relate to the overall project's - goals and immediate next steps. +is difficult to describe as one unit of work, please consider splitting it into +two or more issues. + Issues are assigned [labels](#issue-labels) which explain how they relate to + the overall project's goals and immediate next steps. ### Issue Labels The current list of issue labels are [here][link_labels] and include: -* [![Help Wanted](https://img.shields.io/badge/-help%20wanted-159818.svg)][link_helpwanted] *These issues contain a task that a member of the team has determined we need additional help with.* +* [![Help Wanted](https://img.shields.io/badge/-help%20wanted-159818.svg)][link_helpwanted] + *These issues contain a task that a member of the team has determined we need additional + help with.* If you feel that you can contribute to one of these issues, we especially encourage you to do so! -* [![Bugs](https://img.shields.io/badge/-bugs-fc2929.svg)][link_bugs] *These issues point to problems in the project.* +* [![Bugs](https://img.shields.io/badge/-bugs-fc2929.svg)][link_bugs] + *These issues point to problems in the project.* If you find new a bug, please give as much detail as possible in your issue, including steps to recreate the error. If you experience the same bug as one already listed, please add any additional information that you have as a comment. -* [![Feature](https://img.shields.io/badge/-feature-0052cc.svg)][link_feature] *These issues are asking for new features to be added to the project.* +* [![Feature](https://img.shields.io/badge/-feature-0052cc.svg)][link_feature] + *These issues are asking for new features to be added to the project.* Please try to make sure that your requested feature is distinct from any others that have already been requested or implemented. If you find one that's similar but there are subtle differences, please reference the other request in your issue. - ## Making a change We appreciate all contributions to ``sMRIPrep``, @@ -99,19 +105,21 @@ 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 ``sMRIPrep`` 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 ``sMRIPrep`` 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 blog][link_pushpullblog] is a nice explanation of why putting this work in up front -is so useful to everyone involved. +[This blog][link_pushpullblog] is a nice explanation of why putting this work in +up front is so useful to everyone involved. **2. [Fork][link_fork] the [sMRIPrep repository][link_sMRIPrep] to your profile.** This is now your own unique copy of ``sMRIPrep``. -Changes here won't effect anyone else's work, so it's a safe space to explore edits to the code! +Changes here won't effect anyone else's work, so it's a safe space to explore edits +to the code! -Make sure to [keep your fork up to date][link_updateupstreamwiki] with the master repository. +Make sure to [keep your fork up to date][link_updateupstreamwiki] with the master +repository. **3. Make the changes you've discussed, following the [sMRIPrep coding style guide](#sMRIPrep-coding-style-guide).** @@ -185,27 +193,27 @@ myworkflow_lh_wf = init_workflow_wf(name='myworkflow_lh_wf') myworkflow_rh_wf = init_workflow_wf(name='myworkflow_rh_wf') ``` - ## Licensing ``sMRIPrep`` is licensed under the BSD 3-clause license. By contributing to `sMRIPrep`, you acknowledge that any contributions will be licensed under the same terms. - ## Recognizing contributions -We welcome and recognize all contributions from documentation to testing to code development. +We welcome and recognize all contributions from documentation to testing to code +development. You can see a list of current contributors in our [zenodo file][link_zenodo]. If you are new to the project, don't forget to add your name and affiliation there! -## Thank you! +## Thank you You're awesome. :wave::smiley: -
+  -*— Based on contributing guidelines from the [STEMMRoleModels][link_stemmrolemodels] project.* +*— Based on contributing guidelines from the +[STEMMRoleModels][link_stemmrolemodels] project.* [link_github]: https://github.com/ [link_sMRIPrep]: https://github.com/poldracklab/smriprep