Add contribution documentation #29

zkat · 2017-02-16T04:49:54Z

This PR adds a Code of Conduct as well as a contributing guide. Hopefully, this will give folks hoping to contribute a clear idea of what to expect, as well as information on what they can do and how they can do it.

Before I complete this PR, it would be really great to get feedback on the general structure of CONTRIBUTING.md in case I'm just making some grave mistake. Cause it's a lot of writing to be doing :\

This CoC is adapted from the WeAllJS Code of Conduct. Since that one is primarily based around Slack communities, some changes needed to be made to make it usable on GitHub.

coveralls · 2017-02-16T04:52:09Z

Coverage remained the same at 88.03% when pulling d3fb602 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T05:22:26Z

Coverage remained the same at 88.03% when pulling 0fe1236 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T05:25:44Z

Coverage remained the same at 88.03% when pulling 8037689 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T05:27:50Z

Coverage remained the same at 88.03% when pulling 8037689 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T05:42:40Z

Coverage remained the same at 88.03% when pulling fee7472 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T07:20:33Z

Coverage remained the same at 88.03% when pulling c7ba4ff on zkat/contributing into 7f7242c on latest.

varjmes · 2017-02-16T11:39:45Z

CODE_OF_CONDUCT.md

+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers of this projet pledge to making participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, technical preferences, nationality, personal appearance, race, religion, or sexual identity and orientation.


"projet" should be "project"

it's fine. It's French.

varjmes · 2017-02-16T11:46:03Z

CONTRIBUTING.md

+
+Please make sure to read the relevant section before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience fo all involved. 💚
+
+Don't worry if the document seems long: You probably only need to read one little section for whatever you'd like to do. 😉


I don't think this sentence is needed at all.

varjmes · 2017-02-16T11:47:30Z

CONTRIBUTING.md

+* [Set up the project](#project-setup).
+* Edit or add any relevant documentation.
+* Make sure your changes are formatted correctly and consistently with the rest of the documentation.
+* Re-read what you wrote, and possibly run a spellchecker on it to make sure you didn't miss anything.


remove "possibly"

varjmes · 2017-02-16T11:48:57Z

CONTRIBUTING.md

+* Make any necessary changes to the source code.
+* Include any [additional documentation](#contribute-documentation) the changes might need.
+* Write tests that verify that your contribution works as expected.
+* In your commit message(s), begin the first line with `COMPONENT:`, where `COMPONENT` is the relevant component, feature, or section of the code. There's no hard line for this, but look at the commit history for ideas.


Would a bug fix also need to be "COMPONENT"?

I feel like I should clarify this cause it got confusing -- and as far as bugfixes though, I think I'm more interested in the component the commit affects, rather than whether something is a bugfix or a feature tweak or whatever? So extract: fix tarball lockup issue rather than fix: tarball extract issue.

An alternative is to just go ahead and use angular-style commit messages, which have a standardized format and some automated tooling built around them. See: https://github.com/conventional-changelog/conventional-changelog-angular/blob/master/convention.md

What do you think? I'm not interested in using semantic-release, but this format would actually let us autogenerate changelogs, which would be handy.

I think I tend to use angular-style. I like that style but having yours clarified, I also understand the component based approach :)

varjmes · 2017-02-16T11:50:20Z

This is fantastic.
Can I steal these for everything I ever do?

🎶 I have some questions, a couple of suggestions (in my review) 🎶

zkat · 2017-02-16T16:17:54Z

@Charlotteis thanks for taking the time to review! It sounds like the format is good, so I'll sit down and bang out the rest of the document so we can do one final review before merging.

And as far as using it goes: please, feel free to use any of the docs here for anything you want. It's all public domain and you know how I am about documentation reuse <3

coveralls · 2017-02-16T16:55:23Z

Coverage remained the same at 88.03% when pulling 34d1e2d on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T18:03:40Z

Coverage remained the same at 88.03% when pulling c53ac05 on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T18:05:00Z

Coverage remained the same at 88.03% when pulling 864261b on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T18:06:52Z

Coverage remained the same at 88.03% when pulling 864261b on zkat/contributing into 7f7242c on latest.

coveralls · 2017-02-16T18:08:13Z

Coverage remained the same at 88.03% when pulling 864261b on zkat/contributing into 7f7242c on latest.

varjmes · 2017-02-16T18:14:58Z

CONTRIBUTING.md

+
+[Needs Access](#join-the-project-team): none
+
+Helping out other users with their questions is a really awesome way of contributing to any community. It's not uncommon for most of the issues on an open source projects being simply support-related questions by users trying to understand something they ran into, or find their way around a known bug.


remove "simply"

varjmes · 2017-02-16T18:15:49Z

CONTRIBUTING.md

+
+One of the most important tasks in handling issues is labeling them usefully and accurately. All other tasks involving issues ultimately rely on the issue being classified in such a way that relevant parties looking to do their own tasks can find them quickly and easily.
+
+In order to label issues, simply [open up the list of unlabeled issues](https://github.com/zkat/pacote/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, **from newest to oldest**, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, simply skip the issue and try the next one: don't feel obligated to label each and every issue yourself!


remove "simply" x 2

coveralls · 2017-02-16T18:24:18Z

Coverage remained the same at 88.03% when pulling f59ac0d on zkat/contributing into 7f7242c on latest.

zkat · 2017-02-16T19:19:44Z

@Charlotteis could you review again? This is done.

coveralls · 2017-02-16T19:21:32Z

Coverage remained the same at 88.03% when pulling 92faf5e on zkat/contributing into 7f7242c on latest.

varjmes · 2017-02-16T20:15:54Z

CONTRIBUTING.md

+
+[Needs Access](#join-the-project-team): Issue Handler
+
+While anyone can comment on a PR, add feedback, etc, PRs are only approved for merger by team members with Issue Handler or higher permissions.


"approved for merge" sounds better than "approved or merger" to me.

varjmes · 2017-02-16T20:18:43Z

One nitpick.

Also, a question: What 'role' do I have? Committer, Labeller, Owner, Admin?
I see I have the tag 'Collaborator' and I have committed, so I am assuming committer with labelling abilities? :) Just want to know so I know what the other roles look like.

coveralls · 2017-02-16T21:53:59Z

Coverage remained the same at 88.03% when pulling 44d0e79 on zkat/contributing into 7f7242c on latest.

varjmes · 2017-02-16T21:57:40Z

This is great!

Issues for the following sections:

Merge Pull Requests
Tag a Release

Should be created :)

varjmes · 2017-02-16T22:05:35Z

I also created two issues to fill the remaining two sections.

This is awesome. Thanks for writing this and I look forward to using them in my own projects.

docs: Add Code of Conduct

c1fcf17

This CoC is adapted from the WeAllJS Code of Conduct. Since that one is primarily based around Slack communities, some changes needed to be made to make it usable on GitHub.

zkat added documentation in-progress labels Feb 16, 2017

zkat force-pushed the zkat/contributing branch from d3fb602 to 0fe1236 Compare February 16, 2017 05:19

zkat force-pushed the zkat/contributing branch from 0fe1236 to bb0408b Compare February 16, 2017 05:23

doc: added license file

79efd80

zkat force-pushed the zkat/contributing branch from bb0408b to 8037689 Compare February 16, 2017 05:23

zkat force-pushed the zkat/contributing branch from 8037689 to fee7472 Compare February 16, 2017 05:39

zkat mentioned this pull request Feb 16, 2017

Add contribution documentation zkat/cacache#20

Closed

zkat force-pushed the zkat/contributing branch from fee7472 to c7ba4ff Compare February 16, 2017 07:19

varjmes self-requested a review February 16, 2017 11:38

varjmes suggested changes Feb 16, 2017

View reviewed changes

varjmes approved these changes Feb 16, 2017

View reviewed changes

zkat force-pushed the zkat/contributing branch 2 times, most recently from c53ac05 to 4e7de93 Compare February 16, 2017 18:02

zkat force-pushed the zkat/contributing branch from 4e7de93 to 864261b Compare February 16, 2017 18:04

varjmes reviewed Feb 16, 2017

View reviewed changes

zkat force-pushed the zkat/contributing branch from f59ac0d to 92faf5e Compare February 16, 2017 19:18

zkat removed the in-progress label Feb 16, 2017

varjmes suggested changes Feb 16, 2017

View reviewed changes

docs: Added CONTRIBUTING.md

44d0e79

zkat force-pushed the zkat/contributing branch from 92faf5e to 44d0e79 Compare February 16, 2017 21:50

varjmes approved these changes Feb 16, 2017

View reviewed changes

varjmes merged commit 1a3e8e9 into latest Feb 16, 2017

varjmes deleted the zkat/contributing branch February 16, 2017 22:05

varjmes mentioned this pull request Feb 16, 2017

Add CONTRIBUTING.md #23

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add contribution documentation #29

Add contribution documentation #29

zkat commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes Feb 16, 2017

zkat Feb 16, 2017

varjmes Feb 16, 2017

varjmes Feb 16, 2017

zkat Feb 16, 2017

varjmes Feb 16, 2017

varjmes Feb 16, 2017

varjmes Feb 16, 2017

zkat Feb 16, 2017

varjmes Feb 16, 2017

varjmes commented Feb 16, 2017

zkat commented Feb 16, 2017

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes Feb 16, 2017

varjmes Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

zkat commented Feb 16, 2017

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes Feb 16, 2017

varjmes commented Feb 16, 2017

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes commented Feb 16, 2017 •

edited

Loading

varjmes commented Feb 16, 2017


		## Our Pledge

		In the interest of fostering an open and welcoming environment, we as contributors and maintainers of this projet pledge to making participation in our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, technical preferences, nationality, personal appearance, race, religion, or sexual identity and orientation.


		Please make sure to read the relevant section before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience fo all involved. 💚

		Don't worry if the document seems long: You probably only need to read one little section for whatever you'd like to do. 😉


		[Needs Access](#join-the-project-team): none

		Helping out other users with their questions is a really awesome way of contributing to any community. It's not uncommon for most of the issues on an open source projects being simply support-related questions by users trying to understand something they ran into, or find their way around a known bug.


		One of the most important tasks in handling issues is labeling them usefully and accurately. All other tasks involving issues ultimately rely on the issue being classified in such a way that relevant parties looking to do their own tasks can find them quickly and easily.

		In order to label issues, simply [open up the list of unlabeled issues](https://github.com/zkat/pacote/issues?q=is%3Aopen+is%3Aissue+no%3Alabel) and, from newest to oldest, read through each one and apply issue labels according to the table below. If you're unsure about what label to apply, simply skip the issue and try the next one: don't feel obligated to label each and every issue yourself!


		[Needs Access](#join-the-project-team): Issue Handler

		While anyone can comment on a PR, add feedback, etc, PRs are only approved for merger by team members with Issue Handler or higher permissions.

Add contribution documentation #29

Add contribution documentation #29

Conversation

zkat commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

varjmes commented Feb 16, 2017

zkat commented Feb 16, 2017

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

coveralls commented Feb 16, 2017 • edited Loading

Choose a reason for hiding this comment

varjmes Feb 16, 2017 • edited Loading

Choose a reason for hiding this comment

coveralls commented Feb 16, 2017 • edited Loading

zkat commented Feb 16, 2017

coveralls commented Feb 16, 2017 • edited Loading

Choose a reason for hiding this comment

varjmes commented Feb 16, 2017

coveralls commented Feb 16, 2017 • edited Loading

varjmes commented Feb 16, 2017 • edited Loading

varjmes commented Feb 16, 2017

zkat commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

coveralls commented Feb 16, 2017 •

edited

Loading

varjmes commented Feb 16, 2017 •

edited

Loading