Add CONTRIBUTING.md file #25
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| We're excited that you're here and equally thrilled to know that you want to contribute. :superhero: | ||
|
|
||
| BIDS-Apps is the collection of containerized neuroimaging workflows and pipelines that accept datasets organized according to the Brain Imaging Data Structure (BIDS). To learn more please visit the [BIDS-Apps Webpage](http://bids-apps.neuroimaging.io) |
There was a problem hiding this comment.
separated the lines - makes it easier for future reviewing and editing because the diff will be more readable
| BIDS-Apps is the collection of containerized neuroimaging workflows and pipelines that accept datasets organized according to the Brain Imaging Data Structure (BIDS). To learn more please visit the [BIDS-Apps Webpage](http://bids-apps.neuroimaging.io) | |
| BIDS-Apps are a collection of containerized neuroimaging workflows and pipelines that accept datasets organized according to the Brain Imaging Data Structure (BIDS). | |
| To learn more please visit our [Homepage](http://bids-apps.neuroimaging.io) |
CONTRIBUTING.md
Outdated
|
|
||
| ## 3. Create a pull request :zap: | ||
|
|
||
| Pull requests with patches, improvements and new features are a great help. Please keep them clean from unwanted commits (One Commit One PR Rule) |
There was a problem hiding this comment.
perhaps linking to this best practice to help teach why this may be a good approach?
CONTRIBUTING.md
Outdated
| cd bids-apps.github.io | ||
|
|
||
| # Assign the original repo to a remote called "upstream" | ||
| git remote add upstream https://github.com/BIDS-Apps/bids-apps.github.io.git |
There was a problem hiding this comment.
| git remote add upstream https://github.com/BIDS-Apps/bids-apps.github.io.git | |
| git remote add upstream git@github.com:BIDS-Apps/bids-apps.github.io.git |
CONTRIBUTING.md
Outdated
|
|
||
| [Open a Pull Request.](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) | ||
|
|
||
| A maintainer/developer will review and might suggest some changes before merging them into the codebase. |
There was a problem hiding this comment.
| A maintainer/developer will review and might suggest some changes before merging them into the codebase. | |
| A maintainer/developer will review and might suggest some changes before merging them into the repository. |
CONTRIBUTING.md
Outdated
| git checkout -b <topic-branch-name> | ||
| ``` | ||
|
|
||
| #### 4. Locally rebase the upstream master branch into your topic branch: |
There was a problem hiding this comment.
perhaps rebasing for each contribution may set the barrier to contribute to high. This may be taken in the context of how a contribution to this repository would look like
CONTRIBUTING.md
Outdated
|
|
||
| ## 5. A Special Note :high_brightness: | ||
|
|
||
| Thank you for your valuable contribution! :smiley: |
There was a problem hiding this comment.
| Thank you for your valuable contribution! :smiley: | |
| Thank you for reading through and we look forward to your valuable contribution! :smiley: |
CONTRIBUTING.md
Outdated
|
|
||
| We appreciate the hard work and are so grateful of the contributors who have added core features and improved existing ones throughout the history of the project. :raised_hands: | ||
|
|
||
| Keep up the good work, the community remembers you. :bowtie: |
There was a problem hiding this comment.
| Keep up the good work, the community remembers you. :bowtie: |
CONTRIBUTING.md
Outdated
|
|
||
| Thank you for your valuable contribution! :smiley: | ||
|
|
||
| We appreciate the hard work and are so grateful of the contributors who have added core features and improved existing ones throughout the history of the project. :raised_hands: |
There was a problem hiding this comment.
| We appreciate the hard work and are so grateful of the contributors who have added core features and improved existing ones throughout the history of the project. :raised_hands: | |
| We appreciate the hard work and time of our contributors who have built and maintained BIDS-Apps! :raised_hands: |
CONTRIBUTING.md
Outdated
|
|
||
| ## 4. Get in touch with us :mailbox_with_mail: | ||
|
|
||
| If you have any question, comment or suggestion, feel free to create an issue on our repo because that will be the fastest and easiest way of communicating us. |
There was a problem hiding this comment.
| If you have any question, comment or suggestion, feel free to create an issue on our repo because that will be the fastest and easiest way of communicating us. | |
| If you have any questions, comments, or suggestions, please feel free to create an issue [here](https://github.com/BIDS-Apps/bids-apps.github.io/issues)! A Maintainer or community member will follow up. |
CONTRIBUTING.md
Outdated
| -  *It indicates that an issue or pull request needs more information.* | ||
| These issues are some questions regarding the project that might need clarifications and a bit of discussion. | ||
|
|
||
| ## 3. Create a pull request :zap: |
There was a problem hiding this comment.
preserve consistency between our bids-specification and bids-starter kit contributing guides
| ## 3. Create a pull request :zap: | |
| ## 3. Making a change with a pull request :zap: |
CONTRIBUTING.md
Outdated
|
|
||
| Pull requests with patches, improvements and new features are a great help. Please keep them clean from unwanted commits (One Commit One PR Rule) | ||
|
|
||
| Follow the steps to get your work included in the project. |
There was a problem hiding this comment.
more stylistic - I think we want to nurture contributions rather than making them appear rigidly defined
| Follow the steps to get your work included in the project. |
|
|
||
| #### 5. Open a Pull Request with a clear title and description against the master branch. | ||
|
|
||
| [Open a Pull Request.](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) |
There was a problem hiding this comment.
perhaps this step can use our existing documentation
|
|
||
| *** | ||
|
|
||
| ## 5. A Special Note :high_brightness: |
There was a problem hiding this comment.
May also be beneficial to add a section on how we recongize contributions in BIDS
|
thank you for putting together this pull request @hastagAB ! Overall, this could be a good starting place for building out the Contributing Guide for BIDS-Apps! One general question I had after reading through was how a contribution to this repository would look like (e.g. adding an App). This could be a future contribution. I've gone through and added some comments. I think it has elements of our BIDS starter kit Contributing Guide and BIDS specification Contributing Guide throughout. I think it would be beneficial to preserve a level of consistency across the repositories. |
Thank you for the review @franklin-feingold ! I've modified the file according to your suggested changes. Please have a look again to see if anything is missing or needs to be changed. I'm yet to learn more about the BIDS Community and its workflow so I might have missed some key points or the context. Please suggest any required changes. |
|
|
||
| ## 2. Labels :label: | ||
|
|
||
| Labels let us identify different types of issues, pull requests and helps in categorizing them based on their characteristics. Please take a look at the different types of labels we use. |
There was a problem hiding this comment.
it appears we also have a dependencies and wontfix tags - I think that'll be good to add for the initial contributing file
|
Thanks! It is shaping up!
I think only adding in this file because it is information specific to BIDS-Apps rather than say the BIDS-Specification. Though, that section can be the subject of a future contribution because the guidelines are currently under development. Perhaps adding a section titled I think future PRs will target specific features of contributing to this repository. Once this is in I'll open an issue that can start crowdsourcing useful BIDS-App specific contributions to address. |
|
Yes, thanks for the feedback. Now it looks more consistent and similar to other BIDS repositories. I've added the labels and squashed the commits. Please have a look. |
There was a problem hiding this comment.
Thanks for incorporating @hastagAB ! I think this is a good initial offering - I'll keep this open for another day in case a fellow community member has feedback
|
Thanks! Looking forward to contributing more to the BIDS Community! 😃 |
|
thanks @hastagAB ! |
Added CONTRIBUTING.md file
Issue Ref: #6
Took Reference from:
Please suggest any changes or add-ons if required.