Update contributing docs #1574

EnTeQuAk · 2017-09-28T12:00:32Z

This got heavily inspired by the web-ext contribution docs, kudos for
them!

remove grunt commands that are already documented via 'scripts' section

This got heavily inspired by the web-ext contribution docs, kudos for them! Fix #1572

… via 'scripts' section

coveralls · 2017-09-28T12:04:52Z

Coverage remained the same at 100.0% when pulling e2655a5 on 1572-update-contribution-docs into d3e429f on master.

coveralls · 2017-09-28T12:04:52Z

Coverage remained the same at 100.0% when pulling e2655a5 on 1572-update-contribution-docs into d3e429f on master.

muffinresearch · 2017-09-28T12:48:33Z

CONTRIBUTING.md

+process of contributing patches, have a read through these
+[good first bugs](https://github.com/mozilla/web-ext/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+bug%22).
+
+If you are already familiar with the process or want to contribute even more we appreciate any help on our [contrib: welcome](https://github.com/mozilla/addons-linter/issues?q=is%3Aissue+is%3Aopen+label%3A"contrib%3A+welcome) issues.


Maybe something like this:

If you're already familiar with the project or would like take on something a little more challenging, please take a look at the [contrib: welcome](%LINK%) issues.

tofumatt

I have some editorial comments but if you make them I'd say r+wc 😄

tofumatt · 2017-09-28T12:45:28Z

CONTRIBUTING.md

@@ -1,20 +1,144 @@
-Thanks for wanting to contribute to Mozilla's Add-ons Linter! You rock! 😊
+Hi! Thanks for wanting to contribute to Mozilla's Add-ons Linter! You rock! 😊


tofumatt · 2017-09-28T12:49:30Z

CONTRIBUTING.md


-## Submitting a Pull Request
+The linter is used in various stages of [WebExtension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions)


This sentence is phrased a bit awkwardly and it makes it hard to parse. Also I'm pretty sure we're not supposed to say WebExtensions? I dunno. Saying "contributions are awesome" is a bit of a generic call-to-action as well, but I'd encourage people involved with extensions to relay their experience and get involved... I'd try:

This linter is used to help develop and publish [extensions](https://developer.mozilla.org/en-US/Add-ons/WebExtensions) for Firefox. You're an add-on developer, we would really value your contributions–no one knows add-on development and publishing better than an add-on developer!

tofumatt · 2017-09-28T12:51:11Z

CONTRIBUTING.md

-Please run the tests locally with `npm test` before you commit.
+- [Picking an issue](#picking-an-issue)
+- [Installation](#installation)
+  - [Develop all the things](#develop-all-the-things)


I know that "All the things" is a cute meme but not everyone gets memes, especially non-Western, English-speaking folks. This could be better written as "Development environment".

But actually looking at that section I think it can be removed and folded into testing.

tofumatt · 2017-09-28T12:52:14Z

CONTRIBUTING.md

+- [Picking an issue](#picking-an-issue)
+- [Installation](#installation)
+  - [Develop all the things](#develop-all-the-things)
+  - [Run all application tests](#run-all-application-tests)


This should be "Testing the linter" and the "develop all the things" section should be moved under it to "Run tests when you make changes"

tofumatt · 2017-09-28T12:55:01Z

CONTRIBUTING.md

+
+# Picking an issue
+
+If you're looking for a small task to work on so you can get familiar with the


I'd change this whole paragraph to:

For first-time contributors or those who want to start with a small task: [check out our list of good first bugs](https://github.com/mozilla/web-ext/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+bug%22). These issues have an assigned mentor to help you out and are great issues for learning about the linter and our development process.

tofumatt · 2017-09-28T12:58:33Z

CONTRIBUTING.md

+
+    npm test
+
+The other commands below are just variations on this.


I don't think you need this line.

tofumatt · 2017-09-28T12:59:23Z

CONTRIBUTING.md

+    Fixes #123
+
+The issue number in this case is "123."
+The word *Fixes* is magical; github will automatically close the issue when your


"github" -> "GitHub"

tofumatt · 2017-09-28T12:59:49Z

CONTRIBUTING.md

+
+Good commit messages serve at least three important purposes:
+
+* To speed up the reviewing process.


The "to" in front of these bullet points aren't quite right... I'd say "they" instead of "to".

tofumatt · 2017-09-28T13:01:20Z

CONTRIBUTING.md

+
+* To speed up the reviewing process.
+* To help us write a good release note.
+* To help the future maintainers of addons-linter (it could be you!), say five years into the future, to find out why a particular change was made to the code or why a specific feature was added.


This sentence is too long especially compared to the others. I'd just say "They help future maintainers understand your change and the reasons behind it."

tofumatt · 2017-09-28T13:01:31Z

CONTRIBUTING.md

+Good commit messages serve at least three important purposes:
+
+* To speed up the reviewing process.
+* To help us write a good release note.


"They help us write good release notes"

…pdate-contribution-docs

coveralls · 2017-10-06T17:51:22Z

Coverage remained the same at 100.0% when pulling e3f00a6 on 1572-update-contribution-docs into 8fc2c5c on master.

coveralls · 2017-10-06T17:51:22Z

Coverage remained the same at 100.0% when pulling e3f00a6 on 1572-update-contribution-docs into 8fc2c5c on master.

pdehaan · 2017-10-06T18:32:34Z

CONTRIBUTING.md


-## Submitting a Pull Request
+This linter is used to help develop and publish [Add-ons](https://developer.mozilla.org/en-US/Add-ons/) for Firefox. You're an add-on developer, we would really value your contributions–no one knows add-on development and publishing better than an add-on developer!


You may want to remove the /en-US/ directory and let MDN redirect to the user's preferred locale.

oh good point, damn copy & paste. Thanks!

coveralls · 2017-10-09T07:51:56Z

Coverage remained the same at 100.0% when pulling 3f7c14d on 1572-update-contribution-docs into 8fc2c5c on master.

coveralls · 2017-10-09T07:51:56Z

Coverage remained the same at 100.0% when pulling 3f7c14d on 1572-update-contribution-docs into 8fc2c5c on master.

EnTeQuAk added 2 commits September 28, 2017 13:20

Update contributing docs

91bcbbf

This got heavily inspired by the web-ext contribution docs, kudos for them! Fix #1572

More logs cleanups, remove grunt commands that are already documented…

e2655a5

… via 'scripts' section

EnTeQuAk requested review from muffinresearch and tofumatt September 28, 2017 12:41

muffinresearch reviewed Sep 28, 2017

View reviewed changes

tofumatt approved these changes Sep 28, 2017

View reviewed changes

Fold in review comments. Thanks @tofumatt and @muffinresearch

bd3ff7b

EnTeQuAk force-pushed the 1572-update-contribution-docs branch from 12ddf20 to bd3ff7b Compare October 6, 2017 17:46

Merge branch 'master' of github.com:mozilla/addons-linter into 1572-u…

e3f00a6

…pdate-contribution-docs

pdehaan reviewed Oct 6, 2017

View reviewed changes

Remove en-US

3f7c14d

EnTeQuAk merged commit 08e2b1e into master Oct 9, 2017

EnTeQuAk deleted the 1572-update-contribution-docs branch October 9, 2017 07:50

snyk-bot mentioned this pull request Nov 18, 2020

[Snyk] Fix for 1 vulnerabilities sirinartk/addons-linter#6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update contributing docs #1574

Update contributing docs #1574

EnTeQuAk commented Sep 28, 2017

coveralls commented Sep 28, 2017

coveralls commented Sep 28, 2017

muffinresearch Sep 28, 2017 •

edited

Loading

tofumatt left a comment

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

tofumatt Sep 28, 2017

coveralls commented Oct 6, 2017

coveralls commented Oct 6, 2017

pdehaan Oct 6, 2017

EnTeQuAk Oct 9, 2017

coveralls commented Oct 9, 2017

coveralls commented Oct 9, 2017

		@@ -1,20 +1,144 @@
		Thanks for wanting to contribute to Mozilla's Add-ons Linter! You rock! 😊
		Hi! Thanks for wanting to contribute to Mozilla's Add-ons Linter! You rock! 😊


		## Submitting a Pull Request
		The linter is used in various stages of [WebExtension](https://developer.mozilla.org/en-US/Add-ons/WebExtensions)


		# Picking an issue

		If you're looking for a small task to work on so you can get familiar with the


		npm test

		The other commands below are just variations on this.


		Good commit messages serve at least three important purposes:

		* To speed up the reviewing process.


		## Submitting a Pull Request
		This linter is used to help develop and publish [Add-ons](https://developer.mozilla.org/en-US/Add-ons/) for Firefox. You're an add-on developer, we would really value your contributions–no one knows add-on development and publishing better than an add-on developer!

Update contributing docs #1574

Update contributing docs #1574

Conversation

EnTeQuAk commented Sep 28, 2017

coveralls commented Sep 28, 2017

coveralls commented Sep 28, 2017

muffinresearch Sep 28, 2017 • edited Loading

Choose a reason for hiding this comment

tofumatt 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 6, 2017

coveralls commented Oct 6, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

coveralls commented Oct 9, 2017

coveralls commented Oct 9, 2017

muffinresearch Sep 28, 2017 •

edited

Loading