Update Contribution Guide #179

Open
wants to merge 4 commits into
from

Projects

None yet

3 participants

@bnb
Owner
bnb commented Jan 8, 2017

Updates to some basic contribution content in the repo, including adding a (missing) Contributor Code of Conduct, updating the CONTRIBUTING.md to be less of a direct copy and paste from awesome, and updating the PR template.

This was triggered by #175, which changed the way we needed to word some things in the guidelines and similar meta content.

@matheuss @iamstarkov @darahak Would be 💯 if you could review! 🙏

added some commits Jan 8, 2017
@bnb Add Contributor Covenant
Add Contributor Covenant to the project.
3c0ce8b
@bnb Revise CONTRIBUTING.md
Revise CONTRIBUTING.md to be more accurate to `awesome-hyper` and less of a copy and paste from `awesome`.
eab4a3d
@bnb Reword and restructure PULL_REQUEST_TEMPLATE.md
Reworded and restructured some things in `PULL_REQUEST_TEMPLATE.md` to make them more approachable, concise, and understandable.
70c39d7
@bnb Add resource comment to PULL_REQUEST_TEMPLATE.md
Clarified the **Link** section on PULL_REQUEST_TEMPLATE.md to have a note about links to resources.
afb7a48
@iamstarkov

everything looks great.

just want some discussion about pull_request_template

-- [ ] Put your awesome item at the **BOTTOM** of the correct (plugin, theme, or resource) list.
-- [ ] **VERY IMPORTANT:** I've written a short (one sentence) description for my package or theme as the description of the awesome plugin, theme, or resource in the README.md file I'm submitting in the PR.
+- [ ] **Title:** The title for the addition uses its npm title (`hyper-example`) or the resource's title.
+- [ ] **Link:** The link for the addition uses the npmjs.com link (`https://www.npmjs.com/package/hyper-example`) or the resource's full URI.
@iamstarkov
iamstarkov Jan 9, 2017 Collaborator

this is always hitting me, no one ever in the history of this repo update this specific point correctly. so in order to check out package, you have to go to the diff and manually copy the url =(

@iamstarkov
iamstarkov Jan 9, 2017 Collaborator

actually nobody updates this whole template =(

@iamstarkov
iamstarkov Jan 9, 2017 Collaborator

how can we address this?

@iamstarkov
iamstarkov Jan 9, 2017 Collaborator

shall we simplify it and ask just for relevant link and picture?

@darahak
darahak Jan 12, 2017 Collaborator

By "update", do you mean editing the package name and URL from the template, or just checking the boxes?

@iamstarkov
iamstarkov Jan 13, 2017 Collaborator

ofcourse, everybody check the boxes, but yeah nobody update package name and url from the template

@darahak
darahak Jan 13, 2017 Collaborator

FWIW I was not aware it needed to be replaced.

I think there are multiple issues with the current format.

  • We are asking contributors to add explicit title and description to their PRs. Then the package name is often already in the PR title, so it may feel redundant sometimes.
  • The check boxes get a lot of attention: it feels like you just have to check them all to validate your PR, so people may just rush through it without reading everything.
  • The use of "example" is misleading IMO. If it's really an example, I'm not supposed to change it. Since the format rules are already in CONTRIBUTING.md, this could be made more explicit like <your package name here> and <your package URL here>.
@darahak

The whole thing looks good to me.
Just a few details to fix here and there.

-- Use the following format: `[List Name](link) - Your awesome description`
-- Link additions should be added to the bottom of the relevant category.
-- New categories or improvements to the existing categorization are welcome.
+- Search previous requests for additions to awesome-hyper before making a new one - your request may be a duplicate.
@darahak
darahak Jan 12, 2017 Collaborator

Should we use back-ticks for every occurrence of awesome-hyper? It's used on the next line so I'm wondering.

+- Make an individual pull request for each suggestion to `awesome-hyper`.
+- For Hyper **package** and **theme** names, please use the package name as published on npm, and as displayed in the URI of the package.
+ - As an example, the title of `https://www.npmjs.com/package/hyper-snazzy` would be `hyper-snazzy`
+- For new suggestions, use the following formatting `[hyper-plugin-name](link) - Your awesome description`
@darahak
darahak Jan 12, 2017 Collaborator

I would just add a dot at the end of the formatting example.

-Thank you for your suggestions!
+Suggestions for ammendments to these guidelines are always welcome - feel free to submit an issue or pull request.
@darahak
darahak Jan 12, 2017 Collaborator

ammendments should be amendments

-
-1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
-2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
+1. Access awesome-hyper's GitHub page [here](https://github.com/awesome-hyper)
@darahak
darahak Jan 12, 2017 Collaborator

Invalid URL: it's missing your username in the path.

-1. Access the awesome list's GitHub page. For example: https://github.com/sindresorhus/awesome
-2. Click on the `readme.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
+1. Access awesome-hyper's GitHub page [here](https://github.com/awesome-hyper)
+2. Click on the `README.md` file: ![Step 2 Click on Readme.md](https://cloud.githubusercontent.com/assets/170270/9402920/53a7e3ea-480c-11e5-9d81-aecf64be55eb.png)
3. Now click on the edit icon. ![Step 3 - Click on Edit](https://cloud.githubusercontent.com/assets/170270/9402927/6506af22-480c-11e5-8c18-7ea823530099.png)
4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). ![Step 4 - Edit the file](https://cloud.githubusercontent.com/assets/170270/9402932/7301c3a0-480c-11e5-81f5-7e343b71674f.png)
@darahak
darahak Jan 12, 2017 Collaborator

This link redirects me to https://help.github.com/categories/writing-on-github/
Maybe add this one instead or one of the sections?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment