From 5e7c8d3a792c50a5cffde7aa4263391613c459b3 Mon Sep 17 00:00:00 2001 From: Gaurang Tandon <1gaurangtandon@gmail.com> Date: Sat, 22 Dec 2018 01:57:22 +0530 Subject: [PATCH] Attempts to improve .github contents (#787) * attempts to improve .github contents * more changes * restructure nature of issue remove redundant information in first block comment (it's already mentioned above each section's heading) --- .github/CODE_OF_CONDUCT.md | 7 ++++--- .github/CONTRIBUTING.md | 6 ++---- .github/ISSUE_TEMPLATE.md | 15 +++++++-------- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++------ 4 files changed, 17 insertions(+), 21 deletions(-) diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md index 59a8aa83..9fc20b52 100644 --- a/.github/CODE_OF_CONDUCT.md +++ b/.github/CODE_OF_CONDUCT.md @@ -11,13 +11,14 @@ Use your best judgement. If it will possibly make others uncomfortable, do not post it. -* **Be respectful.** Disagreement is not an opportunity to attack someone else's thoughts or opinions. Although views may differ, remember to approach every situation with patience and care. -* **Be considerate.** Think about how your contribution will affect others in the community. +* **Be respectful.** Disagreement is not an opportunity to attack someone else's thoughts or opinions. Although views may differ, remember to approach every situation with patience and care. +* **Be considerate.** Think about how your contribution will affect others in the community. * **Be open minded.** Embrace new people and new ideas. Our community is continually evolving and we welcome positive change. If you believe someone is violating the code of conduct, we ask that you report it by emailing [hello@p5js.org](mailto:hello@p5js.org). Please include your name and a description of the incident, and we will get back to you ASAP. -Participants asked to stop any harassing behavior are expected to comply immediately. If a participant engages in harassing behavior, the p5.js Team may take any action they deem appropriate, up to and including expulsion from all p5.js spaces and identification of the participant as a harasser to other p5.js members or the general public. +Participants asked to stop any harassing behavior are expected to comply immediately. If a participant engages in harassing behavior, the p5.js Team may take any action they deem appropriate, up to and including expulsion from all p5.js spaces and identification of the participant as a harasser to other p5.js members or the general public. ## Also + * You can read our [community statement](http://p5js.org/community/) on our website. \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3762e68e..430593d8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to the p5.js Web Editor -Hello! We welcome community contributions to the p5.js Web Editor. Contributing takes many forms and doesn't have to be **writing code**, it can be **report bugs**, **proposing new features**, **creating UI/UX designs**, and **updating documentation**. +Hello! We welcome community contributions to the p5.js Web Editor. Contributing takes many forms and doesn't have to be **writing code**, it can be **report bugs**, **proposing new features**, **creating UI/UX designs**, and **updating documentation**. Here are links to all the sections in this document: @@ -72,6 +72,4 @@ Structure your commit message like this: Tips ---- -* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`. - - +* If it seems difficult to summarize what your commit does, it may be because it includes several logical changes or bug fixes, and are better split up into several commits using `git add -p`. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 52f67cac..3750f16f 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,23 +1,22 @@ #### Nature of issue? -- [ ] Found a bug -- [ ] Existing feature enhancement -- [ ] New feature request + + +- Found a bug +- Existing feature enhancement +- New feature request #### Details about the bug: - Web browser and version: - Operating System: -- Steps to reproduce this: +- Steps to reproduce this bug: + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fce149ef..cbe15e3f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,7 +1,5 @@ -Before your pull request is reviewed and merged, please ensure that: +I have verified that this pull request: -* [ ] there are no linting errors -- `npm run lint` -* [ ] your code is in a uniquely-named feature branch and has been rebased on top of the latest master. If you're asked to make more changes, make sure you rebase onto master then too! -* [ ] your pull request is descriptively named and links to an issue number, i.e. `Fixes #123` - -Thank you! +* [ ] has no linting errors (`npm run lint`) +* [ ] is from a uniquely-named feature branch and has been rebased on top of the latest master. (If I was asked to make more changes, I have made sure to rebase onto master then too) +* [ ] is descriptively named and links to an issue number, i.e. `Fixes #123` \ No newline at end of file