Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Adds 'quick start' guidelines for new contributors #293

Merged
merged 10 commits into from
May 30, 2019
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,11 @@ Already know what you're looking for in this guide? Jump to the following sectio
* [Structuring contributions](#style-guide)
* [Recognizing contributors](#recognizing-contributions)

Don't know where to get started?
Read [Joining the conversation](#joining-the-conversation) and pop into
Gitter to introduce yourself! Let us know what your interests are and we
will help you find an issue to contribute to. Thanks so much!

## Joining the conversation

`tedana` is a young project maintained by a growing group of enthusiastic developers— and we're excited to have you join!
Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,10 @@ Open or comment on one of [our issues](https://github.com/ME-ICA/tedana/issues)!

We ask that all contributions to ``tedana`` respect our [code of conduct](https://github.com/ME-ICA/tedana/blob/master/CODE_OF_CONDUCT.md).

## Contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still want this heading, just below the quick start recommendation 😸

Also, WDYT about moving up this text to above the code of conduct reminder ? That way it's clear that the CoC governs gitter, too. At least, that's how I'd read it !

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, I totally missed this comment until @tsalo pointed it out, my bad. The subtraction was another merge casualty; I really need to be more careful next time.

What would you think about additionally adding a line to clarify that the CoC applies broadly across the project, just to be super-duper clear? I (optimistically) hope it never becomes an issue, but at least then it's clear.

If you're not sure where to begin,
feel free to pop into [Gitter](https://gitter.im/ME-ICA/tedana) and
introduce yourself! We will be happy to help you find somewhere to get
started.

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Expand Down