Add code of conduct #30

bermannoah · 2017-11-13T09:26:21Z

Not sure which emails we should list for contact purposes. Went with mine and @julik's for now. Also added a rudimentary set of contributor guidelines based on our eslint config repo.

Closes #29.

@julik

Not sure which emails we should list for conduct. Went with mine and @julik's for now.

julik

Primarily JS-isms in the CONTRIBUTING doc. Maybe we should have a look if some small nice Ruby projects have docs we could copy?

julik · 2017-11-13T10:15:54Z

CONTRIBUTING.md

+[features requests](#feature-requests) and [submitting pull
+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** use the issue tracker for personal support requests (use


TBH we don't have enough exposure to divert to SO yet, so I would drop this clause until this becomes a necessity. If #21 ended up on SO I probably wouldn't even have found it, let alone used it as something actionable.

julik · 2017-11-13T10:16:56Z

CONTRIBUTING.md

+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).


It's prudent to add that the project used Rubocop, which can be run with bundle exec rubocop -c .rubocop.yml

julik · 2017-11-13T10:17:08Z

CONTRIBUTING.md

+   # Clone your fork of the repo into the current directory
+   git clone git@github.com:WeTransfer/eslint-config-wetransfer.git
+   # Navigate to the newly cloned directory
+   cd eslint-config-wetransfer


Paths and stuff

julik · 2017-11-13T10:18:33Z

CONTRIBUTING.md

+   git checkout -b <topic-branch-name>
+   ```
+
+4. Commit your changes in logical chunks. Please adhere to these [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y)


I would limit to "commit your changes in logical chunks or squash them for readability and conciseness" or some such. How Angular is relevant here I don't even know (as in: I do get it that we ported these conventions from the eslit-config repo but still). A link to a general tips page re. writing good commit messages could suffice IMO.

julik · 2017-11-13T10:19:22Z

CONTRIBUTING.md

+Removing features on repo
+
+```bash
+git commit -m "refactor: message about this" -m "BREAKING CHANGE: message about the breaking change"


This was never used on this repo, semver that we use implies that breaking changes are permitted as long as the major version is increased on released. I don't like this convention and I don't think we need it.

julik · 2017-11-13T10:19:47Z

CONTRIBUTING.md

+Adding features on repo
+
+```bash
+git commit -m "feat: message about this feature"


See below (no "feat:", "churn:", "BREAKING CHANGE:" etc. commit message prefixes). There is a CHANGELOG for this.

julik · 2017-11-13T10:20:35Z

CODE_OF_CONDUCT.md

+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at julik@wetransfer.com and/or noah@wetransfer.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.


I like it that this gets handled via email first, instead of GH 👍

bermannoah · 2017-11-13T13:01:47Z

@julik Pushed some changes per your comments. :)

julik · 2017-11-16T11:11:35Z

@WJWH @felixbuenemann could you guys have a look? I would like to merge this soon.

felixbuenemann · 2017-11-16T16:39:16Z

CODE_OF_CONDUCT.md

+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.


Given that it is unlikely that there is a Website, Social Media Account or Official Email for a library, does it make sense to include the stuff about "public spaces" here?

The github repo is the de-facto website I'd think. Also online or offline event could still apply.

I think it's usefully harmless, in that if we want to give a talk about the library or reference it somewhere we might as well have the catch-all, even if it's not something we will likely encounter.

OK, I have no objections to keeping it as is.

felixbuenemann · 2017-11-16T16:42:56Z

CONTRIBUTING.md

+ - [zip files](https://en.wikipedia.org/wiki/Zip_(file_format))
+
+
+# How do I made a contribution?


Typo: s/made/make/

felixbuenemann · 2017-11-16T16:43:45Z

CONTRIBUTING.md

+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bug-reports),
+[features requests](#feature-requests) and [submitting pull


s/features requests/feature requests/

felixbuenemann · 2017-11-16T16:45:10Z

CONTRIBUTING.md

+requests](#pull-requests), but please respect the following restrictions:
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and
+  respect the opinions of others.


Add link to CoC here?

felixbuenemann · 2017-11-16T16:51:27Z

CONTRIBUTING.md

+
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository.


I'd drop "the" at the beginning of "the code in the repository" for better readability.

felixbuenemann · 2017-11-16T17:52:00Z

CONTRIBUTING.md

+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case, if possible


Might be useful to add a linked reference to [Gist](https://gist.github.com) as a way to share test cases.

felixbuenemann · 2017-11-16T17:55:57Z

CONTRIBUTING.md

+
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic


Replace n-dashes with m-dashes. You don't need to use — on macOS they can be entered using Cmd+-.

felixbuenemann · 2017-11-16T17:57:19Z

CONTRIBUTING.md

+otherwise you risk spending a lot of time working on something that the
+project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation,


s/a project/the project/

felixbuenemann · 2017-11-16T18:05:22Z

CONTRIBUTING.md

+Please adhere to the coding conventions used throughout a project (indentation,
+accurate comments, etc.) and any other requirements (such as test coverage).
+
+The project uses Rubocop which can be run using `bundle exec rubocop -c .rubocop.yml`.


How about:

The project uses Rubocop to enforce a consistent code style.
You can run bundle exec rubocop from the root of the repository to see what needs to be fixed.

I think specifying -c .rubocop.yml is redundant or does it avoid using a user specific config?

Also if we mention how to run rubocop, should we mention how to run rspec here as well since the previous paragraph mentions test coverage?

felixbuenemann · 2017-11-16T18:12:49Z

CONTRIBUTING.md

+    with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.


I would add a reference to the license, like:

See LICENSE.txt at the top of the repository for details.

felixbuenemann · 2017-11-16T18:15:05Z

I have submitted a review with a bunch of suggested changes, none of these are blockers for merging.

WJWH · 2017-11-17T10:09:41Z

CODE_OF_CONDUCT.md

+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at julik@wetransfer.com and/or noah@wetransfer.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.


In practice this would involve removing commit rights, right? Why not just say that instead of leaving it at some nebulous "consequences"?

Planning for a worst-case scenario - we want to keep it vague so people don't think "Oh, I can be terrible to other users and all they'll do is remove my commits."

WJWH · 2017-11-17T10:44:19Z

CONTRIBUTING.md

+
+A good bug report shouldn't leave others needing to chase you up for more
+information. Please try to be as detailed as possible in your report. What is
+your environment? What steps will reproduce the issue? What browser(s) and OS


bermannoah · 2017-11-17T13:48:25Z

Have pushed some updates. Thanks much everyone. I'll take a look at creating a sample spec script, but considering that we refer to the contents of the testing directory as "the real tests" maybe I can add language pointing people there?

julik · 2017-11-17T13:50:12Z

I think we can do that later. The testing thing also gets matched and ran as it were a part of the test suite (due to the name), whereas it's actually meant as manual QA, so the directory probably also has to be renamed.

bermannoah · 2017-11-17T13:51:27Z

Sounds good to me. Are we happy with what we have now?

bermannoah and others added 2 commits November 13, 2017 10:13

Create a Code of Conduct for zip_tricks

4b3826f

Not sure which emails we should list for conduct. Went with mine and @julik's for now.

Add contributing guidelines

897411c

bermannoah requested a review from julik November 13, 2017 09:26

julik suggested changes Nov 13, 2017

View reviewed changes

julik requested review from felixbuenemann and WJWH November 13, 2017 10:52

Edits for guideline clarity

09a3cdf

julik approved these changes Nov 16, 2017

View reviewed changes

felixbuenemann reviewed Nov 16, 2017

View reviewed changes

WJWH approved these changes Nov 17, 2017

View reviewed changes

Contributing document updates

0271f4a

julik merged commit 9569e2c into master Nov 17, 2017

bermannoah deleted the add-code-of-conduct-1 branch November 17, 2017 13:53

This comment has been minimized.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add code of conduct #30

Add code of conduct #30

bermannoah commented Nov 13, 2017

julik left a comment

julik Nov 13, 2017

julik Nov 13, 2017

julik Nov 13, 2017

julik Nov 13, 2017

julik Nov 13, 2017

julik Nov 13, 2017

julik Nov 13, 2017

bermannoah commented Nov 13, 2017

julik commented Nov 16, 2017

felixbuenemann Nov 16, 2017

WJWH Nov 17, 2017

bermannoah Nov 17, 2017

felixbuenemann Nov 17, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann Nov 16, 2017

felixbuenemann commented Nov 16, 2017

WJWH Nov 17, 2017

bermannoah Nov 17, 2017

WJWH Nov 17, 2017

bermannoah commented Nov 17, 2017

julik commented Nov 17, 2017

bermannoah commented Nov 17, 2017

This comment has been minimized.


		## Enforcement

		Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at julik@wetransfer.com and/or noah@wetransfer.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.


		## Scope

		This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

		- [zip files](https://en.wikipedia.org/wiki/Zip_(file_format))


		# How do I made a contribution?


		## Bug reports

		A bug is a _demonstrable problem_ that is caused by the code in the repository.


		## Pull requests

		Good pull requests - patches, improvements, new features - are a fantastic


		Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at julik@wetransfer.com and/or noah@wetransfer.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

		Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Add code of conduct #30

Add code of conduct #30

Conversation

bermannoah commented Nov 13, 2017

julik left a 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

bermannoah commented Nov 13, 2017

julik commented Nov 16, 2017

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

felixbuenemann commented Nov 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bermannoah commented Nov 17, 2017

julik commented Nov 17, 2017

bermannoah commented Nov 17, 2017

This comment has been minimized.