From a1e4143a583c2592a0d7bc81c5e31b88d19b2e6b Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:31:49 -0500 Subject: [PATCH 01/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 89 +++++++++++++++++++++++++++++++++++++------------ 1 file changed, 68 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d211bb1..61a3a43 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,39 +4,81 @@ Thank you for expressing interest in contributing to our CSS exercises! Please b **Please do not open a pull request (PR) with your solutions to any exercises in this repo**. Your PR will be immediately closed without being merged. The exercises are for you to do and keep on your own local machine or your personal GitHub. +## Table of Contents +* [Label Meanings](#label-meanings) +* [Being Assigned an Issue](#being-assigned-an-issue) +* [Creating an Issue](#creating-an-issue) +* [Setting Up Your Local Clone](#setting-up-your-local-clone) +* [Working on an Issue](#working-on-an-issue) +* [Opening a Pull Request](#opening-a-pull-request) +* [Further Help](#further-help) + +## Label Meanings + +The labels that get applied to issues and PRs have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. + +### Status Labels +* Abandoned: This issue/PR has been abandoned, and no further work or review should be done +* Accepted: This PR has been accepted and merged +* Awaiting Changes: Waiting for requested changes to be made +* Awaiting Response: Waiting for a response from the contributor +* Completed: This issue has been completed and a PR has been made +* Do Not Merge: This PR should not be merged +* Do Not Review: This PR should not be reviewed +* Help Wanted: Contributors can ask to be assigned this issue +* In Progress: This issue/PR is actively being worked on +* Invalid: The template or another item in the issue/PR is invalid or not relevant +* Investigating: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed +* Needs Review: This PR needs a review from one or more maintainers +* On Hold: There is a temporary hold on any continued work or review +* Under Review: This issue/PR is actively being reviewed by at least one maintainer + +### Type Labels +* Accessibility: Involves an accessibility feature or requires review for accessibility +* Bug: Something isn't working as intended +* Chore: Involves changes to the build process or internal tooling +* Documentation: Involves an update to the documentation +* Duplicate: This issue/PR already exists and should not be worked on or reviewed +* Enhancement: Involves a new feature or enhancement request +* Good First Issue: Good for beginner contributors +* Hacktoberfest: This issue is a good Hacktoberfest participation +* Maintainer Only: This issue is available only to maintainers + ## How to Contribute ### Being Assigned an Issue If you would like to work on an existing issue in the repo: -1) Find an issue that is not currently assigned to anyone - * A couple of good places to start are ["help wanted" issues](https://github.com/TheOdinProject/css-exercises/labels/Help%20Wanted) or ["good first issue" issues](https://github.com/TheOdinProject/css-exercises/labels/good%20first%20issue) +1) Find an issue that is not currently assigned to anyone. + * A couple of good places to start are ["help wanted" issues](https://github.com/TheOdinProject/css-exercises/labels/Status%3A%20Help%20Wanted) or ["good first issue" issues](https://github.com/TheOdinProject/css-exercises/labels/Type%3A%20Good%20First%20Issue) -2) Ask to be assigned the issue by a maintainer +2) Ask to be assigned the issue by a maintainer. * **If you are not a maintainer, do not give others permission to work on an issue** -3) **Wait to be assigned the issue before starting any work** +3) **Wait to be assigned the issue before starting any work**. -4) After being assigned, address each item listed in the acceptance criteria - * If there are no acceptance criteria stated in the issue, ask the maintainer that assigned you the issue if any exist - -If you would like to propose a small change (fixing a typo, updating a link, etc.) that is not part of an existing issue, you are welcome to make the change and submit a PR without an official issue. +4) After being assigned, address each item listed in the acceptance criteria. + * If there are no acceptance criteria stated in the issue, ask the maintainer that assigned you the issue if any exist. ### Creating an Issue -If you would like to propose a more significant change: +If you would like to make a small change (fixing a typo, updating a link, etc.) that is not part of an existing issue, you are welcome to make the change and submit a PR without creating an official issue. -1. Go through the open issues and make sure an issue doesn't already exist +If you do not wish to make a small change yourself and instead want to create an issue for it, or if you would like to propose a more significant change: + +1. Go through the open issues and make sure an issue doesn't already exist. * If the issue already exists, but there are details you feel are missing, leave a comment on the already opened issue -2. If the issue doesn't already exist, create a new one and **read the issue template in its entirety and fill out all applicable sections** +2. If the issue doesn't already exist, create a new one and **read the issue template in its entirety and fill out all applicable sections**. + * The title of the issue should be in `file/exercise/folder: brief description of issue` format. This makes it easier for anyone to quickly see what an issue is for, reducing the possibility of a duplicate issue from being made. + * If you would like to be assigned the issue you are creating, complete the applicable checkbox in the issue template. Note that this does not guarantee that you will be assigned the issue, but rather it lets maintainers know that you are interested. ### Setting Up Your Local Clone Before you begin working on anything, be sure you follow these steps in order to set up a clone on your local machine: -1. Fork this repo to your own GitHub account. If you don't know how to do so, follow the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) +1. Fork this repo to your own GitHub account. If you don't know how to do so, follow the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo). 2. Clone this repo to your local machine with one of the following commands, replacing the `` text with your actual GitHub username: ```bash @@ -72,26 +114,31 @@ Once you have the repo forked and cloned, and the upstream remote has been set, 4. Push your branch to your forked repo, replacing the `` with the branch you've been working on locally: ```bash - $ git push origin + git push origin ``` - + +5. Preview your proposed changes by locally opening any applicable HTML files (or using VS Code's Live Server extension). If the preview matches the existing "Desired Outcome" image(s) for the exercise, continue to open a pull request. Otherwise, update any images in your local clone and commit + push those changes before opening a pull request. + ### Opening a Pull Request -1. After pushing your changes, go to your forked repo on GitHub and click the "Compare & pull request" button +1. After pushing your changes, go to your forked repo on GitHub and click the "Compare & pull request" button. * If you don't see this button, you can click the branch dropdown menu and then select the branch you just pushed from your local clone: ![GitHub branch dropdown menu](https://user-images.githubusercontent.com/70952936/150646139-bc080c64-db57-4776-8db1-6525b7b47be2.jpg) - * Once you have switched to the correct branch on GitHub, click the "Contribute" dropdown and then click the "Open pull request" button + * Once you have switched to the correct branch on GitHub, click the "Contribute" dropdown and then click the "Open pull request" button. -2. **Read the PR template in its entirety and fill out all applicable sections** before submitting your PR +2. **Read the PR template in its entirety and fill out all applicable sections** before submitting your PR. + * The title of the PR should be in `file/exercise/folder: brief description of change` format, e.g. `01 flex center: add hint for XYZ`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. + * Be sure you describe the change(s) you are proposing in more detail in Step 1 of the PR template. If the PR is not related to an open issue, you should also include why your proposed changes are beneficial or what problem(s) it solves. + * If the PR is related to an open issue, be sure to link that issue in Step 2 of the PR template by replacing the `XXXXX` with the issue number, e.g. `Closes #2013` -3. At this point a maintainer will either leave general comments, request changes, or approve and merge your PR - * It is important to respond to any comments or requested changes in a timely manner, otherwise your PR may be closed without being merged due to inactivity +3. At this point a maintainer will either leave general comments, request changes, or approve and merge your PR. + * It is important to respond to any comments or requested changes in a timely manner, otherwise your PR may be closed without being merged due to inactivity. * After pushing any requested changes to the branch you opened the PR with, be sure to re-request a review from the maintainer that requested those changes at the top of the right sidebar: ![Reviewers section of GitHub's sidebar](https://user-images.githubusercontent.com/70952936/150647064-4fdd59d1-82a4-4f18-894d-0e43a5ee0ffb.jpg) -## Need Further Help? -Please let us know if you require any help doing any of the steps in this guide in our Discord's [contribution-suggestions channel](https://discordapp.com/channels/505093832157691914/540903304046182425). +## Further Help +Please let us know if you require any further help with any of the steps in this guide in our Discord's [contribution-suggestions channel](https://discordapp.com/channels/505093832157691914/540903304046182425). From 24caf40c622780edff3485bc60aa90f16ac066b1 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:35:10 -0500 Subject: [PATCH 02/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61a3a43..b7218d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,7 +121,7 @@ Once you have the repo forked and cloned, and the upstream remote has been set, ### Opening a Pull Request -1. After pushing your changes, go to your forked repo on GitHub and click the "Compare & pull request" button. +1. After pushing your changes, go to your forked repo on GitHub and click the "Compare & pull request" button. If you have multiples of this button, be sure you click the one for the correct branch. * If you don't see this button, you can click the branch dropdown menu and then select the branch you just pushed from your local clone: ![GitHub branch dropdown menu](https://user-images.githubusercontent.com/70952936/150646139-bc080c64-db57-4776-8db1-6525b7b47be2.jpg) From 8180561bbdc5db5c63aee979e67ae1759f449b8e Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:41:25 -0500 Subject: [PATCH 03/27] Create bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 34 ++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..29171a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'Type: Bug' +assignees: '' + +--- + +- [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) +- [ ] The title of this issue is in `file/exercise/folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` + + +- [ ] If approved, I would like to be assigned this issue to work on it + +**Description of the Bug** + + +**How To Reproduce** + + +**Expected Behavior** + + +**Desktop/Device:** + - Device: + - OS: + - Browser + - Version + +**Additional Information** + From afe4faa2a6b805ea85b71f5f3603c0bc76ac613f Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:42:24 -0500 Subject: [PATCH 04/27] Create feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0611ec5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature Request +about: Suggest a new feature for this project +title: '' +labels: 'Type: Enhancement' +assignees: '' + +--- + +- [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) +- [ ] The title of this issue is in `file/exercise/folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` + + +- [ ] If approved, I would like to be assigned this issue to work on it + +**Description of the Feature Request** + + +**Additional Information** + From d637df6ed9c86ef04c73328d6e0eb3a4b08a3282 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 11:42:40 -0500 Subject: [PATCH 05/27] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 29171a2..f498076 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,5 +1,5 @@ --- -name: Bug report +name: Bug Report about: Create a report to help us improve title: '' labels: 'Type: Bug' From 9bd534d501e1d0445b7889041fb8a289f34cf394 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 17:00:42 -0500 Subject: [PATCH 06/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7218d8..a85a2a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,7 @@ The labels that get applied to issues and PRs have specific meanings and are bro * Investigating: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed * Needs Review: This PR needs a review from one or more maintainers * On Hold: There is a temporary hold on any continued work or review +* Stale: This issue/PR has been inactive for over 30 days and may be closed if inactivity continues * Under Review: This issue/PR is actively being reviewed by at least one maintainer ### Type Labels From 257eba880576d7d110ed217921f149408cf73217 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:24:39 -0500 Subject: [PATCH 07/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a85a2a0..4231a9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,13 +23,14 @@ The labels that get applied to issues and PRs have specific meanings and are bro * Awaiting Changes: Waiting for requested changes to be made * Awaiting Response: Waiting for a response from the contributor * Completed: This issue has been completed and a PR has been made +* Discussion: This issue/PR is actively being discussed * Do Not Merge: This PR should not be merged -* Do Not Review: This PR should not be reviewed +* Do Not Review: This issue/PR should not be reviewed * Help Wanted: Contributors can ask to be assigned this issue * In Progress: This issue/PR is actively being worked on * Invalid: The template or another item in the issue/PR is invalid or not relevant * Investigating: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed -* Needs Review: This PR needs a review from one or more maintainers +* Needs Review: This issue/PR needs a review from one or more maintainers * On Hold: There is a temporary hold on any continued work or review * Stale: This issue/PR has been inactive for over 30 days and may be closed if inactivity continues * Under Review: This issue/PR is actively being reviewed by at least one maintainer @@ -42,7 +43,7 @@ The labels that get applied to issues and PRs have specific meanings and are bro * Duplicate: This issue/PR already exists and should not be worked on or reviewed * Enhancement: Involves a new feature or enhancement request * Good First Issue: Good for beginner contributors -* Hacktoberfest: This issue is a good Hacktoberfest participation +* Hacktoberfest: This issue/PR is a good Hacktoberfest participation * Maintainer Only: This issue is available only to maintainers ## How to Contribute From 9878f2de3db27ef2a733feb77cba0d2800a955f4 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 23 Jan 2022 21:51:57 -0500 Subject: [PATCH 08/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4231a9c..2da8786 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,9 +24,9 @@ The labels that get applied to issues and PRs have specific meanings and are bro * Awaiting Response: Waiting for a response from the contributor * Completed: This issue has been completed and a PR has been made * Discussion: This issue/PR is actively being discussed -* Do Not Merge: This PR should not be merged -* Do Not Review: This issue/PR should not be reviewed -* Help Wanted: Contributors can ask to be assigned this issue +* Do Not Merge: This PR should not be merged until further notice +* Do Not Review: This issue/PR should not be reviewed until further notice +* Help Wanted: This issue can be assigned to other contributors * In Progress: This issue/PR is actively being worked on * Invalid: The template or another item in the issue/PR is invalid or not relevant * Investigating: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed From 731f32477992bfc5b2c059e952faea58f5b0c83b Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 08:02:54 -0500 Subject: [PATCH 09/27] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0611ec5..2c8efb4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,21 +2,24 @@ name: Feature Request about: Suggest a new feature for this project title: '' -labels: 'Type: Enhancement' +labels: ['Type: Enhancement', 'Status: Needs Review'] assignees: '' --- - + + + - [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is in `file/exercise/folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` - + - [ ] If approved, I would like to be assigned this issue to work on it -**Description of the Feature Request** + +**1. Description of the Feature Request** -**Additional Information** + +**2. Additional Information** + From 7c88a0e2a5f4f4d90beab3503675898b38be4f31 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 08:06:01 -0500 Subject: [PATCH 10/27] Fix multiple default labels --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2c8efb4..5c452d9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature Request about: Suggest a new feature for this project title: '' -labels: ['Type: Enhancement', 'Status: Needs Review'] +labels: 'Status: Needs Review, Type: Enhancement' assignees: '' --- From ea660bf5fa9123aa445289c026c94a2704e41c1b Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 08:08:19 -0500 Subject: [PATCH 11/27] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 29 ++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f498076..08fb86f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -2,33 +2,38 @@ name: Bug Report about: Create a report to help us improve title: '' -labels: 'Type: Bug' +labels: 'Status: Needs Review, Type: Bug' assignees: '' --- - + + + - [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is in `file/exercise/folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` - + - [ ] If approved, I would like to be assigned this issue to work on it -**Description of the Bug** + +**1. Description of the Bug** -**How To Reproduce** + +**2. How To Reproduce** -**Expected Behavior** + +**3. Expected Behavior** -**Desktop/Device:** + +**4. Desktop/Device:** - Device: - OS: - - Browser - - Version + - Browser: + - Version: -**Additional Information** +**5. Additional Information** + From c4579b975b1ca99168939b9067d6eb47fa56e1b3 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:07:07 -0500 Subject: [PATCH 12/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2da8786..b37b279 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,10 +130,11 @@ Once you have the repo forked and cloned, and the upstream remote has been set, * Once you have switched to the correct branch on GitHub, click the "Contribute" dropdown and then click the "Open pull request" button. -2. **Read the PR template in its entirety and fill out all applicable sections** before submitting your PR. +2. **Read the PR template in its entirety before filling it out and submitting a PR**. Not filling out the template correctly will delay a PR getting merged. + * If a checkbox is not required and is not applicable to your PR, do not complete it. If your PR isn't related to an open issue, for example, you shouldn't complete the checkbox for linking an issue. * The title of the PR should be in `file/exercise/folder: brief description of change` format, e.g. `01 flex center: add hint for XYZ`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. - * Be sure you describe the change(s) you are proposing in more detail in Step 1 of the PR template. If the PR is not related to an open issue, you should also include why your proposed changes are beneficial or what problem(s) it solves. - * If the PR is related to an open issue, be sure to link that issue in Step 2 of the PR template by replacing the `XXXXX` with the issue number, e.g. `Closes #2013` + * Be sure you describe the change(s) you are proposing in more detail in Step 1 of the PR template. If the PR is not related to an open issue, you should also include why your proposed changes are beneficial or what problem(s) it solves. This gives maintainers the information to consider when deciding whether a PR should be merged. + * If the PR is related to an open issue, be sure to link that issue in Step 2 of the PR template. This can be done either by replacing the `XXXXX` with the issue number, e.g. `Closes #2013`, or if the issue is in another TOP repo replacing the `#XXXXX` with the URL of the issue, e.g. `Closes https://github.com/TheOdinProject/curriculum/issues/XXXXX`. This streamlines the issue closing process, as an issue that is linked to a PR will be closed when that PR gets merged. 3. At this point a maintainer will either leave general comments, request changes, or approve and merge your PR. * It is important to respond to any comments or requested changes in a timely manner, otherwise your PR may be closed without being merged due to inactivity. From d57a220d074abe839c6bc5253a609f5d72f9e76f Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:13:07 -0500 Subject: [PATCH 13/27] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 5c452d9..02672b0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,16 +6,15 @@ labels: 'Status: Needs Review, Type: Enhancement' assignees: '' --- - + - -- [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) + +- [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is in `file/exercise/folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` - [ ] If approved, I would like to be assigned this issue to work on it - **1. Description of the Feature Request** From 4bfc2f2d36ba1f90b49634c127867251fcd29f71 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 24 Jan 2022 12:13:15 -0500 Subject: [PATCH 14/27] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 08fb86f..546031d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,16 +6,15 @@ labels: 'Status: Needs Review, Type: Bug' assignees: '' --- - + - -- [ ] I have thoroughly read the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) + +- [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is in `file/exercise/folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` - [ ] If approved, I would like to be assigned this issue to work on it - **1. Description of the Bug** From cd1b331a44d055a91e6b9873b99470c7015b638e Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sat, 29 Jan 2022 10:24:21 -0500 Subject: [PATCH 15/27] Add clarification for suggestions on Discord --- CONTRIBUTING.md | 69 +++++++++++++++++++++++++++++++------------------ 1 file changed, 44 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b37b279..a121728 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ Thank you for expressing interest in contributing to our CSS exercises! Please b ## Table of Contents * [Label Meanings](#label-meanings) +* [How to Contribute](#how-to-contribute) * [Being Assigned an Issue](#being-assigned-an-issue) * [Creating an Issue](#creating-an-issue) * [Setting Up Your Local Clone](#setting-up-your-local-clone) @@ -18,36 +19,54 @@ Thank you for expressing interest in contributing to our CSS exercises! Please b The labels that get applied to issues and PRs have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. ### Status Labels -* Abandoned: This issue/PR has been abandoned, and no further work or review should be done -* Accepted: This PR has been accepted and merged -* Awaiting Changes: Waiting for requested changes to be made -* Awaiting Response: Waiting for a response from the contributor -* Completed: This issue has been completed and a PR has been made -* Discussion: This issue/PR is actively being discussed -* Do Not Merge: This PR should not be merged until further notice -* Do Not Review: This issue/PR should not be reviewed until further notice -* Help Wanted: This issue can be assigned to other contributors -* In Progress: This issue/PR is actively being worked on -* Invalid: The template or another item in the issue/PR is invalid or not relevant -* Investigating: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed -* Needs Review: This issue/PR needs a review from one or more maintainers -* On Hold: There is a temporary hold on any continued work or review -* Stale: This issue/PR has been inactive for over 30 days and may be closed if inactivity continues -* Under Review: This issue/PR is actively being reviewed by at least one maintainer +* **Abandoned**: This issue/PR has been abandoned, and no further work or review should be done +* **Accepted**: This PR has been accepted and merged +* **Awaiting** Changes: Waiting for requested changes to be made +* **Awaiting** Response: Waiting for a response from the contributor +* **Completed**: This issue has been completed and a PR has been made +* **Discussion**: This issue/PR is actively being discussed +* **Do Not Merge**: This PR should not be merged until further notice +* **Do Not Review**: This issue/PR should not be reviewed until further notice +* **Help Wanted**: This issue can be assigned to other contributors +* **In Progress**: This issue/PR is actively being worked on +* **Invalid**: The template or another item in the issue/PR is invalid or not relevant +* **Investigating**: Something is being looked into by a maintainer, but the issue/PR is not being actively reviewed +* **Needs Review**: This issue/PR needs a review from one or more maintainers +* **On Hold**: There is a temporary hold on any continued work or review +* **Stale**: This issue/PR has been inactive for over 30 days and may be closed if inactivity continues +* **Under Review**: This issue/PR is actively being reviewed by at least one maintainer ### Type Labels -* Accessibility: Involves an accessibility feature or requires review for accessibility -* Bug: Something isn't working as intended -* Chore: Involves changes to the build process or internal tooling -* Documentation: Involves an update to the documentation -* Duplicate: This issue/PR already exists and should not be worked on or reviewed -* Enhancement: Involves a new feature or enhancement request -* Good First Issue: Good for beginner contributors -* Hacktoberfest: This issue/PR is a good Hacktoberfest participation -* Maintainer Only: This issue is available only to maintainers +* **Accessibility**: Involves an accessibility feature or requires review for accessibility +* **Bug**: Something isn't working as intended +* **Chore**: Involves changes to the build process or internal tooling +* **Documentation**: Involves an update to the documentation +* **Duplicate**: This issue/PR already exists and should not be worked on or reviewed +* **Enhancement**: Involves a new feature or enhancement request +* **Good First Issue**: Good for beginner contributors +* **Hacktoberfest**: This issue/PR is a good Hacktoberfest participation +* **Maintainer Only**: This issue is available only to maintainers ## How to Contribute +The complexity of a change can determine how exactly you should go about contributing. Generally, simpler or more minor changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. Things that are simple or more minor that you should feel free to just create an issue or PR can include: + +* Typo or grammar fixes - "I noticed that this sentence in this lesson is using incorrect grammar." +* Simple syntax errors - "This line of code is missing a closing element tag." +* Clarifying questions - "This lesson says to use this syntax, but in a previous lesson we were told to use a different syntax. Which is correct?" +* Small-scale changes - "I think including instructions about X could help minimize confusion at this step." + +On the other hand, if you have a more complex suggestion or notice a more urgent issue, going to our [`contribution-suggestions-bugs-disccusion` Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to get more of a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created and to ask for feedback **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. + +While you should also feel free to just create an issue for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid spending the time to create a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: + +* A complete rewrite of a lesson +* Adding a completely new lesson +* HTML in lessons is not displaying properly +* A new feature for the website + +Regardless of the complexity of a change, when you wish to make a contribution you should follow any further instructions in this guide. + ### Being Assigned an Issue If you would like to work on an existing issue in the repo: From 3e3f72ea106dd3f201fa16782c5fc06973cf6dff Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sat, 29 Jan 2022 13:47:07 -0500 Subject: [PATCH 16/27] Make instructions less repo specific Rather than tailoring contribution guides to the repo they reside in, I decided to make one that was more general and could be simply copy+pasted into each repo where necessary. This can require less upkeep when changes are made (simply copy+paste across all repos rather than needing to comb through and copy+paste only specific sections that were updated). Tailored instructions will be added later, such as instructions for running TOP locally, lesson writing guide (TBA), etc. --- CONTRIBUTING.md | 88 ++++++++++++++++++++++++++++++------------------- 1 file changed, 55 insertions(+), 33 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a121728..afc27d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,13 @@ # CSS Exercises Contributing Guide -Thank you for expressing interest in contributing to our CSS exercises! Please be sure to read this guide thoroughly before contributing, as it will lessen the chances of any issues arising during the process. +Thank you for expressing interest in contributing to The Odin Project! If you are new to contributing to our repos, or to contributing to open-source in general, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. -**Please do not open a pull request (PR) with your solutions to any exercises in this repo**. Your PR will be immediately closed without being merged. The exercises are for you to do and keep on your own local machine or your personal GitHub. +**Please do not open an issue or pull request (PR) with your solutions to any exercise repo**. Your PR will be immediately closed without being merged. The exercise repos are for you to do and keep any work on your own local machine or your personal GitHub. ## Table of Contents * [Label Meanings](#label-meanings) * [How to Contribute](#how-to-contribute) +* [Check Before Doing Anything](#check-before-doing-anything) * [Being Assigned an Issue](#being-assigned-an-issue) * [Creating an Issue](#creating-an-issue) * [Setting Up Your Local Clone](#setting-up-your-local-clone) @@ -16,7 +17,7 @@ Thank you for expressing interest in contributing to our CSS exercises! Please b ## Label Meanings -The labels that get applied to issues and PRs have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. +The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. ### Status Labels * **Abandoned**: This issue/PR has been abandoned, and no further work or review should be done @@ -49,71 +50,80 @@ The labels that get applied to issues and PRs have specific meanings and are bro ## How to Contribute -The complexity of a change can determine how exactly you should go about contributing. Generally, simpler or more minor changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. Things that are simple or more minor that you should feel free to just create an issue or PR can include: +The complexity of a change can determine how exactly you should go about contributing. Generally, simpler changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. Simple changes that you should feel free to just create an issue or PR for can include: * Typo or grammar fixes - "I noticed that this sentence in this lesson is using incorrect grammar." * Simple syntax errors - "This line of code is missing a closing element tag." * Clarifying questions - "This lesson says to use this syntax, but in a previous lesson we were told to use a different syntax. Which is correct?" -* Small-scale changes - "I think including instructions about X could help minimize confusion at this step." +* Other small-scale changes - "I think including instructions about X could help minimize confusion at this step." -On the other hand, if you have a more complex suggestion or notice a more urgent issue, going to our [`contribution-suggestions-bugs-disccusion` Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to get more of a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created and to ask for feedback **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. +If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-disccusion Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. -While you should also feel free to just create an issue for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid spending the time to create a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: +While you should also feel free to just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: * A complete rewrite of a lesson * Adding a completely new lesson * HTML in lessons is not displaying properly * A new feature for the website -Regardless of the complexity of a change, when you wish to make a contribution you should follow any further instructions in this guide. +Regardless of the complexity of a change, when you wish to make a contribution on a TOP repo you should follow any further instructions in this guide. + +### Check Before Doing Anything + +It's important that you look through any open issues or PRs in a repo before attempting to submit a new issue or work on a change, regardless of the complexity. This will help avoid any duplicates from being made, as well as prevent more than one person working on the same thing at the same time. + +If your proposal already exists in an open issue or PR, but you feel therer are details missing, comment on the issue/PR to let those involved know of those missing details. ### Being Assigned an Issue -If you would like to work on an existing issue in the repo: +If you would like to work on an existing issue in a repo: 1) Find an issue that is not currently assigned to anyone. - * A couple of good places to start are ["help wanted" issues](https://github.com/TheOdinProject/css-exercises/labels/Status%3A%20Help%20Wanted) or ["good first issue" issues](https://github.com/TheOdinProject/css-exercises/labels/Type%3A%20Good%20First%20Issue) + * A couple of good places to start are issues with the `Status: Help Wanted` or `Type: Good First Issue` labels. You can filter the issues list to only show ones with these (or any) specific labels to make them easier to find. 2) Ask to be assigned the issue by a maintainer. * **If you are not a maintainer, do not give others permission to work on an issue** 3) **Wait to be assigned the issue before starting any work**. -4) After being assigned, address each item listed in the acceptance criteria. - * If there are no acceptance criteria stated in the issue, ask the maintainer that assigned you the issue if any exist. +4) After being assigned, address each item listed in the acceptance criteria, if any exist. + * If an issue doesn't have any acceptance criteria, feel free to go about resolving the issue however you wish. You can also ask the maintainer that assigned you the issue if there are any specific acceptance criteria. ### Creating an Issue -If you would like to make a small change (fixing a typo, updating a link, etc.) that is not part of an existing issue, you are welcome to make the change and submit a PR without creating an official issue. +1. If you would like to make a simple change that is not part of an existing issue, you are welcome to skip the next step and just submit a PR with your proposed change(s). -If you do not wish to make a small change yourself and instead want to create an issue for it, or if you would like to propose a more significant change: - -1. Go through the open issues and make sure an issue doesn't already exist. - * If the issue already exists, but there are details you feel are missing, leave a comment on the already opened issue - -2. If the issue doesn't already exist, create a new one and **read the issue template in its entirety and fill out all applicable sections**. +2. Create a new issue and **read the issue template in its entirety and fill out all applicable sections**. * The title of the issue should be in `file/exercise/folder: brief description of issue` format. This makes it easier for anyone to quickly see what an issue is for, reducing the possibility of a duplicate issue from being made. * If you would like to be assigned the issue you are creating, complete the applicable checkbox in the issue template. Note that this does not guarantee that you will be assigned the issue, but rather it lets maintainers know that you are interested. ### Setting Up Your Local Clone -Before you begin working on anything, be sure you follow these steps in order to set up a clone on your local machine: +Before you begin working on anything, make sure you follow these steps in order to set up a clone on your local machine: 1. Fork this repo to your own GitHub account. If you don't know how to do so, follow the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo). -2. Clone this repo to your local machine with one of the following commands, replacing the `` text with your actual GitHub username: +2. Clone this repo to your local machine with one of the commands below. Be sure the `` text is replaced with your actual GitHub username, and the `` with the actual repo name. You can also read the GitHub documentaiton on [cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository). + ```bash - # If you have SSH set up with Git - git clone git@github.com:/css-exercises.git - # Otherwise for HTTPS - git clone https://github.com//css-exercises.git + # If you have SSH set up with Git: + git clone git@github.com:/.git + # Otherwise for HTTPS: + git clone https://github.com//.git + + # An example: + git clone git@github.com:Odinson/css-exercises.git ``` -3. `cd` into the directory of your local clone, then set the upstream remote so you can keep your local clone synced with TOP's original repo: +3. `cd` into the directory of your local clone, then set the upstream remote so you can keep your local clone synced with TOP's original repo. The `` below should be the same as the one you used when creating your local clone in the previous step. + ```bash - # If you have SSH set up with Git - git remote add upstream git@github.com:TheOdinProject/css-exercises.git - # Otherwise for HTTPS + # If you have SSH set up with Git: + git remote add upstream git@github.com:TheOdinProject/.git + # Otherwise for HTTPS: + git remote add upstream https://github.com/TheOdinProject/.git + + # An example: git remote add upstream https://github.com/TheOdinProject/css-exercises.git ``` @@ -121,21 +131,33 @@ Before you begin working on anything, be sure you follow these steps in order to Once you have the repo forked and cloned, and the upstream remote has been set, you can begin working on your issue: -1. Create a new branch, replacing the `` with an actual branch name, e.g. "flex_exercises": +1. Create a new branch, replacing the `` with an actual branch name: + ```bash git checkout -b + + # An example: + git checkout -b flex_exercises ``` 2. Add commits as you work on your issue, replacing the `` text with your actual commit message: + ```bash git commit -m "" + + # An example: + git commit -m "Update solution files" ``` -3. Sync your work with the upstream remote every so often. Follow the [ongoing workflow](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/using-git-in-the-real-world#ongoing-workflow) section in our Using Git in the Real World lesson. +3. Sync your work with the upstream remote every so often. Follow the [ongoing workflow](https://www.theodinproject.com/paths/full-stack-ruby-on-rails/courses/ruby-programming/lessons/using-git-in-the-real-world#ongoing-workflow) instructions in our Using Git in the Real World lesson. 4. Push your branch to your forked repo, replacing the `` with the branch you've been working on locally: + ```bash git push origin + + # An example: + git push origin flex_exercises ``` 5. Preview your proposed changes by locally opening any applicable HTML files (or using VS Code's Live Server extension). If the preview matches the existing "Desired Outcome" image(s) for the exercise, continue to open a pull request. Otherwise, update any images in your local clone and commit + push those changes before opening a pull request. @@ -151,7 +173,7 @@ Once you have the repo forked and cloned, and the upstream remote has been set, 2. **Read the PR template in its entirety before filling it out and submitting a PR**. Not filling out the template correctly will delay a PR getting merged. * If a checkbox is not required and is not applicable to your PR, do not complete it. If your PR isn't related to an open issue, for example, you shouldn't complete the checkbox for linking an issue. - * The title of the PR should be in `file/exercise/folder: brief description of change` format, e.g. `01 flex center: add hint for XYZ`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. + * The title of the PR should follow the format described in the PR template, which is usually some variation of `file or lesson: brief description of changes`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. * Be sure you describe the change(s) you are proposing in more detail in Step 1 of the PR template. If the PR is not related to an open issue, you should also include why your proposed changes are beneficial or what problem(s) it solves. This gives maintainers the information to consider when deciding whether a PR should be merged. * If the PR is related to an open issue, be sure to link that issue in Step 2 of the PR template. This can be done either by replacing the `XXXXX` with the issue number, e.g. `Closes #2013`, or if the issue is in another TOP repo replacing the `#XXXXX` with the URL of the issue, e.g. `Closes https://github.com/TheOdinProject/curriculum/issues/XXXXX`. This streamlines the issue closing process, as an issue that is linked to a PR will be closed when that PR gets merged. @@ -163,4 +185,4 @@ Once you have the repo forked and cloned, and the upstream remote has been set, ## Further Help -Please let us know if you require any further help with any of the steps in this guide in our Discord's [contribution-suggestions channel](https://discordapp.com/channels/505093832157691914/540903304046182425). +Please let us know if you require any further help with any of the steps in this guide in our [contribution-suggestions-bugs-disccusion Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425). From 73d76c59c33d767fcaacd713d0c3e020c3ff554a Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sat, 29 Jan 2022 15:49:34 -0500 Subject: [PATCH 17/27] Add repo specific links --- CONTRIBUTING.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index afc27d0..4fce3b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# CSS Exercises Contributing Guide +# The Odin Project Contributing Guide Thank you for expressing interest in contributing to The Odin Project! If you are new to contributing to our repos, or to contributing to open-source in general, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. @@ -7,6 +7,7 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar ## Table of Contents * [Label Meanings](#label-meanings) * [How to Contribute](#how-to-contribute) +* [Repo Specific Instructions](#repo-specific-instructions) * [Check Before Doing Anything](#check-before-doing-anything) * [Being Assigned an Issue](#being-assigned-an-issue) * [Creating an Issue](#creating-an-issue) @@ -17,7 +18,7 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar ## Label Meanings -The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. +The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. ### Status Labels * **Abandoned**: This issue/PR has been abandoned, and no further work or review should be done @@ -57,7 +58,7 @@ The complexity of a change can determine how exactly you should go about contrib * Clarifying questions - "This lesson says to use this syntax, but in a previous lesson we were told to use a different syntax. Which is correct?" * Other small-scale changes - "I think including instructions about X could help minimize confusion at this step." -If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-disccusion Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. +If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-discussions Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. While you should also feel free to just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: @@ -68,6 +69,16 @@ While you should also feel free to just create an issue on a repo for more compl Regardless of the complexity of a change, when you wish to make a contribution on a TOP repo you should follow any further instructions in this guide. +### Repo Specific Instructions + +#### [TOP Website Repo](https://github.com/TheOdinProject/theodinproject) + +Before starting any work on our main website repo, you must read and follow the instructions found on [The Odin Project Wiki](https://github.com/TheOdinProject/theodinproject/wiki). These instructions will help you get the TOP app running locally, and help you with adding new paths, courses, sections, and lessons. + +#### [TOP Curriculum Repo](https://github.com/TheOdinProject/curriculum) + +When submitting a PR for a new lesson, or when you are making significant changes to an existing lesson, you must follow our [Layout Style Guide](https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md). This helps ensure the layout and formatting is consistent across our lessons. + ### Check Before Doing Anything It's important that you look through any open issues or PRs in a repo before attempting to submit a new issue or work on a change, regardless of the complexity. This will help avoid any duplicates from being made, as well as prevent more than one person working on the same thing at the same time. @@ -185,4 +196,4 @@ Once you have the repo forked and cloned, and the upstream remote has been set, ## Further Help -Please let us know if you require any further help with any of the steps in this guide in our [contribution-suggestions-bugs-disccusion Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425). +Please let us know if you require any further help with any of the steps in this guide in our [contribution-suggestions-bugs-discussions Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425). From ca1fc1fe549db16a42b29ae898d87294f92f5ecf Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sat, 29 Jan 2022 18:16:15 -0500 Subject: [PATCH 18/27] Add verbiage explaining curriculum structure --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4fce3b6..58b4ed7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,7 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar **Please do not open an issue or pull request (PR) with your solutions to any exercise repo**. Your PR will be immediately closed without being merged. The exercise repos are for you to do and keep any work on your own local machine or your personal GitHub. ## Table of Contents +* [Common Verbiage](#common-verbiage) * [Label Meanings](#label-meanings) * [How to Contribute](#how-to-contribute) * [Repo Specific Instructions](#repo-specific-instructions) @@ -16,6 +17,15 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar * [Opening a Pull Request](#opening-a-pull-request) * [Further Help](#further-help) +## Curriculum Structure + +Between the website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring to certain parts of the curriculum, both for consistency and to make sure everyone understands what you mean. + +* **Path**: The broadest level of the curriculum structure. When you first start The Odin Project, you will be on the Foundations path. Upon completion of Foundations, you choose one of two different Full Stack paths to continue down. +* **Course**: A path is made up of different courses. A course splits a path into more distinct topics, and each course has its own completion percentage. When asked what course you're on, you might say "I'm on the Getting Hired course!" +* **Section**: A course is made up for different sections. A section splits a course into even more distinct topics. When asked what section you're on, you might say "I just started the Basic Ruby section!" +* **Lesson**: Finally, a section is made of different lessons. This is the most specific level of the curriculum structure. This is the exact thing you're currently on. When asked what lesson you're on, you might say "I'm reading through the Webpack lesson!" + ## Label Meanings The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. From fd98fa80384a49bfde504e0104e50e027c5ff523 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sat, 29 Jan 2022 21:23:17 -0500 Subject: [PATCH 19/27] Update link to curriculum structure --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 58b4ed7..7e13800 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar **Please do not open an issue or pull request (PR) with your solutions to any exercise repo**. Your PR will be immediately closed without being merged. The exercise repos are for you to do and keep any work on your own local machine or your personal GitHub. ## Table of Contents -* [Common Verbiage](#common-verbiage) +* [Curriculum Structure](#curriculum-structure) * [Label Meanings](#label-meanings) * [How to Contribute](#how-to-contribute) * [Repo Specific Instructions](#repo-specific-instructions) @@ -19,16 +19,16 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar ## Curriculum Structure -Between the website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring to certain parts of the curriculum, both for consistency and to make sure everyone understands what you mean. +Between the website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring or contributing to certain parts of the curriculum, both for consistency and to make sure everyone understands what you mean. * **Path**: The broadest level of the curriculum structure. When you first start The Odin Project, you will be on the Foundations path. Upon completion of Foundations, you choose one of two different Full Stack paths to continue down. * **Course**: A path is made up of different courses. A course splits a path into more distinct topics, and each course has its own completion percentage. When asked what course you're on, you might say "I'm on the Getting Hired course!" -* **Section**: A course is made up for different sections. A section splits a course into even more distinct topics. When asked what section you're on, you might say "I just started the Basic Ruby section!" -* **Lesson**: Finally, a section is made of different lessons. This is the most specific level of the curriculum structure. This is the exact thing you're currently on. When asked what lesson you're on, you might say "I'm reading through the Webpack lesson!" +* **Section**: A course is made up of different sections. A section splits a course into even more distinct topics. When asked what section you're on, you might say "I just started the Basic Ruby section!" +* **Lesson**: Finally, a section is made up of different lessons. This is the most specific level of the curriculum structure. This is the exact thing you're currently on. When asked what lesson you're on, you might say "I'm reading through the Webpack lesson!" ## Label Meanings -The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. +The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. The following isn't a complete list, but rather a list of the labels that are universal across all of our repos. ### Status Labels * **Abandoned**: This issue/PR has been abandoned, and no further work or review should be done @@ -66,11 +66,11 @@ The complexity of a change can determine how exactly you should go about contrib * Typo or grammar fixes - "I noticed that this sentence in this lesson is using incorrect grammar." * Simple syntax errors - "This line of code is missing a closing element tag." * Clarifying questions - "This lesson says to use this syntax, but in a previous lesson we were told to use a different syntax. Which is correct?" -* Other small-scale changes - "I think including instructions about X could help minimize confusion at this step." +* Other small-scale changes - "I think including an instruction about X could help minimize confusion at this step." If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-discussions Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. -While you should also feel free to just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: +While you should also feel free to just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid doing work and opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: * A complete rewrite of a lesson * Adding a completely new lesson From 0553ec4342a071bf9cc3113d21042f3afc540661 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 30 Jan 2022 10:57:18 -0500 Subject: [PATCH 20/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e13800..37c9b77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,13 +8,13 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar * [Curriculum Structure](#curriculum-structure) * [Label Meanings](#label-meanings) * [How to Contribute](#how-to-contribute) -* [Repo Specific Instructions](#repo-specific-instructions) -* [Check Before Doing Anything](#check-before-doing-anything) -* [Being Assigned an Issue](#being-assigned-an-issue) -* [Creating an Issue](#creating-an-issue) -* [Setting Up Your Local Clone](#setting-up-your-local-clone) -* [Working on an Issue](#working-on-an-issue) -* [Opening a Pull Request](#opening-a-pull-request) + * [Repo Specific Instructions](#repo-specific-instructions) + * [Check Before Doing Anything](#check-before-doing-anything) + * [Being Assigned an Issue](#being-assigned-an-issue) + * [Creating an Issue](#creating-an-issue) + * [Setting Up Your Local Clone](#setting-up-your-local-clone) + * [Working on an Issue](#working-on-an-issue) + * [Opening a Pull Request](#opening-a-pull-request) * [Further Help](#further-help) ## Curriculum Structure @@ -68,9 +68,9 @@ The complexity of a change can determine how exactly you should go about contrib * Clarifying questions - "This lesson says to use this syntax, but in a previous lesson we were told to use a different syntax. Which is correct?" * Other small-scale changes - "I think including an instruction about X could help minimize confusion at this step." -If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-discussions Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created **if** you haven't seen any activity on the actual issue/PR for a while; just keep in mind that maintainers have busy lives and may not get to things immediately. +If you have a more complex suggestion or notice a more urgent issue, going to our [contribution-suggestions-bugs-discussions Discord channel](https://discordapp.com/channels/505093832157691914/540903304046182425) can be a great way to start a discussion or receive feedback. This channel can also be used to share a link to an issue or PR you have created if you haven't seen any activity on the actual issue/PR for a while, or to have a more real-time discussion. Just keep in mind that maintainers have busy lives - many with day jobs - and may not get to items on our repos immediately. -While you should also feel free to just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid doing work and opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: +While you can also just create an issue on a repo for more complex or urgent changes rather than bring it up on our Discord, generally you should avoid doing work and opening a PR for such changes. Depending what the PR entails, it may not be something we're looking to implement at this time or is not how we wish to go about things, and we don't want all of that time and work going to waste. Changes that may be more complex or urgent can include: * A complete rewrite of a lesson * Adding a completely new lesson From be973a8aa43554e05b1c55f61af254a7f5b1fb16 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Sun, 30 Jan 2022 11:16:38 -0500 Subject: [PATCH 21/27] Mention link in lessons for improving on GitHub --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37c9b77..3d433f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,7 +61,7 @@ The labels that get applied to issues and PRs in our repos have specific meaning ## How to Contribute -The complexity of a change can determine how exactly you should go about contributing. Generally, simpler changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. Simple changes that you should feel free to just create an issue or PR for can include: +The complexity of a change can determine how exactly you should go about contributing. Generally, simpler changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. All of our lessons include a handy "Improve this lesson on GitHub" link to make it even easier to submit simpler change requests. Simple changes that you should feel free to just create an issue or PR for can include: * Typo or grammar fixes - "I noticed that this sentence in this lesson is using incorrect grammar." * Simple syntax errors - "This line of code is missing a closing element tag." From 371577c81eb0cd91f6cabc9323dbdddb3261edcd Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 31 Jan 2022 18:46:43 -0500 Subject: [PATCH 22/27] Add link to GH creating issues doc --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d433f4..0d027f5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # The Odin Project Contributing Guide -Thank you for expressing interest in contributing to The Odin Project! If you are new to contributing to our repos, or to contributing to open-source in general, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. +Thank you for expressing interest in contributing to The Odin Project (TOP)! If you are new to contributing to our repos, or to contributing to open-source in general, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. **Please do not open an issue or pull request (PR) with your solutions to any exercise repo**. Your PR will be immediately closed without being merged. The exercise repos are for you to do and keep any work on your own local machine or your personal GitHub. @@ -21,7 +21,7 @@ Thank you for expressing interest in contributing to The Odin Project! If you ar Between the website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring or contributing to certain parts of the curriculum, both for consistency and to make sure everyone understands what you mean. -* **Path**: The broadest level of the curriculum structure. When you first start The Odin Project, you will be on the Foundations path. Upon completion of Foundations, you choose one of two different Full Stack paths to continue down. +* **Path**: The broadest level of the curriculum structure. When you first start TOP, you will be on the Foundations path. Upon completion of Foundations, you choose one of two different Full Stack paths to continue down. * **Course**: A path is made up of different courses. A course splits a path into more distinct topics, and each course has its own completion percentage. When asked what course you're on, you might say "I'm on the Getting Hired course!" * **Section**: A course is made up of different sections. A section splits a course into even more distinct topics. When asked what section you're on, you might say "I just started the Basic Ruby section!" * **Lesson**: Finally, a section is made up of different lessons. This is the most specific level of the curriculum structure. This is the exact thing you're currently on. When asked what lesson you're on, you might say "I'm reading through the Webpack lesson!" @@ -61,7 +61,7 @@ The labels that get applied to issues and PRs in our repos have specific meaning ## How to Contribute -The complexity of a change can determine how exactly you should go about contributing. Generally, simpler changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. All of our lessons include a handy "Improve this lesson on GitHub" link to make it even easier to submit simpler change requests. Simple changes that you should feel free to just create an issue or PR for can include: +The complexity of a change can determine how exactly you should go about contributing. Generally, simpler changes can just have an issue made or a PR created rather than needing to bring it up on our Discord server. Simple changes that you should feel free to just create an issue or PR for can include: * Typo or grammar fixes - "I noticed that this sentence in this lesson is using incorrect grammar." * Simple syntax errors - "This line of code is missing a closing element tag." @@ -77,7 +77,7 @@ While you can also just create an issue on a repo for more complex or urgent cha * HTML in lessons is not displaying properly * A new feature for the website -Regardless of the complexity of a change, when you wish to make a contribution on a TOP repo you should follow any further instructions in this guide. +Regardless of the complexity of a change, when you wish to make a contribution on one of TOP's repos you should follow any further instructions in this guide. ### Repo Specific Instructions @@ -89,6 +89,8 @@ Before starting any work on our main website repo, you must read and follow the When submitting a PR for a new lesson, or when you are making significant changes to an existing lesson, you must follow our [Layout Style Guide](https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md). This helps ensure the layout and formatting is consistent across our lessons. +If you're new to contributing to open-source, or if you just want to make a really quick change, you can click the "Improve this lesson on GitHub" link found at the end of each lesson instead of going through the methods described later in this guide. + ### Check Before Doing Anything It's important that you look through any open issues or PRs in a repo before attempting to submit a new issue or work on a change, regardless of the complexity. This will help avoid any duplicates from being made, as well as prevent more than one person working on the same thing at the same time. @@ -114,7 +116,7 @@ If you would like to work on an existing issue in a repo: 1. If you would like to make a simple change that is not part of an existing issue, you are welcome to skip the next step and just submit a PR with your proposed change(s). -2. Create a new issue and **read the issue template in its entirety and fill out all applicable sections**. +2. Create a new issue and **read the issue template in its entirety and fill out all applicable sections**. If you aren't sure how to create an issue, you can read the GitHub documentation on [creating an issue from a repository](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository). * The title of the issue should be in `file/exercise/folder: brief description of issue` format. This makes it easier for anyone to quickly see what an issue is for, reducing the possibility of a duplicate issue from being made. * If you would like to be assigned the issue you are creating, complete the applicable checkbox in the issue template. Note that this does not guarantee that you will be assigned the issue, but rather it lets maintainers know that you are interested. From 6bcd754be236de71063fbdd9ce80d0e6004ea086 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 31 Jan 2022 20:13:26 -0500 Subject: [PATCH 23/27] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d027f5..da3f5c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -117,7 +117,7 @@ If you would like to work on an existing issue in a repo: 1. If you would like to make a simple change that is not part of an existing issue, you are welcome to skip the next step and just submit a PR with your proposed change(s). 2. Create a new issue and **read the issue template in its entirety and fill out all applicable sections**. If you aren't sure how to create an issue, you can read the GitHub documentation on [creating an issue from a repository](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-repository). - * The title of the issue should be in `file/exercise/folder: brief description of issue` format. This makes it easier for anyone to quickly see what an issue is for, reducing the possibility of a duplicate issue from being made. + * The title of the issue should follow a format similar to `file, exercise/lesson, or folder: brief description of issue`. This makes it easier for anyone to quickly see what an issue is for, reducing the possibility of a duplicate issue from being made. * If you would like to be assigned the issue you are creating, complete the applicable checkbox in the issue template. Note that this does not guarantee that you will be assigned the issue, but rather it lets maintainers know that you are interested. ### Setting Up Your Local Clone @@ -196,7 +196,7 @@ Once you have the repo forked and cloned, and the upstream remote has been set, 2. **Read the PR template in its entirety before filling it out and submitting a PR**. Not filling out the template correctly will delay a PR getting merged. * If a checkbox is not required and is not applicable to your PR, do not complete it. If your PR isn't related to an open issue, for example, you shouldn't complete the checkbox for linking an issue. - * The title of the PR should follow the format described in the PR template, which is usually some variation of `file or lesson: brief description of changes`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. + * The title of the PR should follow the format described in the PR template, which is usually some variation of `file, exercise/lesson, or folder: brief description of changes`. This makes it easier for anyone to quickly see what a PR is for, reducing the possibility of a duplicate PR from being made. * Be sure you describe the change(s) you are proposing in more detail in Step 1 of the PR template. If the PR is not related to an open issue, you should also include why your proposed changes are beneficial or what problem(s) it solves. This gives maintainers the information to consider when deciding whether a PR should be merged. * If the PR is related to an open issue, be sure to link that issue in Step 2 of the PR template. This can be done either by replacing the `XXXXX` with the issue number, e.g. `Closes #2013`, or if the issue is in another TOP repo replacing the `#XXXXX` with the URL of the issue, e.g. `Closes https://github.com/TheOdinProject/curriculum/issues/XXXXX`. This streamlines the issue closing process, as an issue that is linked to a PR will be closed when that PR gets merged. From b4a8e63dc594fc17a1ef6b9d95da548743cad1a6 Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 31 Jan 2022 20:14:19 -0500 Subject: [PATCH 24/27] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 546031d..b6a6f80 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,7 +10,7 @@ assignees: '' - [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) -- [ ] The title of this issue is in `file/exercise/folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` +- [ ] The title of this issue is similar to the `file, exercise/lesson, or folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` - [ ] If approved, I would like to be assigned this issue to work on it From dd08621c42a2ab69806d9a3768b70439be23ab3c Mon Sep 17 00:00:00 2001 From: Eric Olkowski <70952936+thatblindgeye@users.noreply.github.com> Date: Mon, 31 Jan 2022 20:15:10 -0500 Subject: [PATCH 25/27] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 02672b0..34a92aa 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -10,7 +10,7 @@ assignees: '' - [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) -- [ ] The title of this issue is in `file/exercise/folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` +- [ ] The title of this issue is similar to the `file, exercise/lesson, or folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` - [ ] If approved, I would like to be assigned this issue to work on it From 800f48e75ff7637a5a5a0a6a964078565f3b4969 Mon Sep 17 00:00:00 2001 From: thatblindgeye Date: Mon, 31 Jan 2022 20:54:57 -0500 Subject: [PATCH 26/27] Add clarificatoins --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- CONTRIBUTING.md | 13 +++++++------ 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b6a6f80..1c57b43 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,7 +9,7 @@ assignees: '' -- [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) +- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is similar to the `file, exercise/lesson, or folder: brief description of bug` format, e.g. `01 flex center: solution files do not match desired outcome` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 34a92aa..034f8ad 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -9,7 +9,7 @@ assignees: '' -- [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) +- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/thatblindgeye/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this issue is similar to the `file, exercise/lesson, or folder: brief description of request` format, e.g. `01 flex center: add hint for XYZ` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index a10b872..3afd4c6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,10 +1,10 @@ -- [ ] I have thoroughly read and understand the [CSS Exercises Contributing Guide](https://github.com/TheOdinProject/css-exercises/blob/main/CONTRIBUTING.md) +- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/css-exercises/blob/main/CONTRIBUTING.md) - [ ] The title of this PR is similar to the `file, exercise/lesson, or folder: brief description of changes` format e.g. `01 flex center: add hint for XYZ` - + - [ ] If one exists, I have linked a related open issue to this PR in Step 2 below - [ ] If changes were requested, I have made them and re-requested a review from the maintainer (top of the right sidebar) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da3f5c1..702ea54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # The Odin Project Contributing Guide -Thank you for expressing interest in contributing to The Odin Project (TOP)! If you are new to contributing to our repos, or to contributing to open-source in general, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. +Thank you for expressing interest in contributing to The Odin Project (TOP)! Whether you are a first time contributor or you have made several contributions to our repos, please be sure to read this guide thoroughly before contributing as it will lessen the chances of any issues arising during the process. **Please do not open an issue or pull request (PR) with your solutions to any exercise repo**. Your PR will be immediately closed without being merged. The exercise repos are for you to do and keep any work on your own local machine or your personal GitHub. @@ -19,7 +19,7 @@ Thank you for expressing interest in contributing to The Odin Project (TOP)! If ## Curriculum Structure -Between the website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring or contributing to certain parts of the curriculum, both for consistency and to make sure everyone understands what you mean. +Between our website, repos, and Discord server, you're bound to see certain terms being used in regards to the curriculum structure. It can be important to keep these terms in mind when referring or contributing to certain parts of our curriculum, both for consistency and to make sure everyone understands what you mean. * **Path**: The broadest level of the curriculum structure. When you first start TOP, you will be on the Foundations path. Upon completion of Foundations, you choose one of two different Full Stack paths to continue down. * **Course**: A path is made up of different courses. A course splits a path into more distinct topics, and each course has its own completion percentage. When asked what course you're on, you might say "I'm on the Getting Hired course!" @@ -28,7 +28,7 @@ Between the website, repos, and Discord server, you're bound to see certain term ## Label Meanings -The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. The following isn't a complete list, but rather a list of the labels that are universal across all of our repos. +The labels that get applied to issues and PRs in our repos have specific meanings and are broken into two categories: status and type. An issue/PR should only ever have one status label, but can have multiple type labels. The following isn't a complete list, but rather a list of the labels that are more universal across all of our repos. ### Status Labels * **Abandoned**: This issue/PR has been abandoned, and no further work or review should be done @@ -77,7 +77,7 @@ While you can also just create an issue on a repo for more complex or urgent cha * HTML in lessons is not displaying properly * A new feature for the website -Regardless of the complexity of a change, when you wish to make a contribution on one of TOP's repos you should follow any further instructions in this guide. +Regardless of the complexity of a change, when you wish to make a contribution on one of TOP's repos you must follow any further instructions in this guide. ### Repo Specific Instructions @@ -87,9 +87,9 @@ Before starting any work on our main website repo, you must read and follow the #### [TOP Curriculum Repo](https://github.com/TheOdinProject/curriculum) -When submitting a PR for a new lesson, or when you are making significant changes to an existing lesson, you must follow our [Layout Style Guide](https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md). This helps ensure the layout and formatting is consistent across our lessons. +When submitting a PR for a new lesson, or when you are making significant changes to an existing lesson, you must follow our [Layout Style Guide](https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md). This helps ensure the layout and formatting is consistent across all of our lessons. -If you're new to contributing to open-source, or if you just want to make a really quick change, you can click the "Improve this lesson on GitHub" link found at the end of each lesson instead of going through the methods described later in this guide. +If you're new to contributing to open-source, or if you just want to make a really quick PR, you can click the "Improve this lesson on GitHub" link found at the end of each lesson instead of going through the steps to fork + clone one of our repos. ### Check Before Doing Anything @@ -103,6 +103,7 @@ If you would like to work on an existing issue in a repo: 1) Find an issue that is not currently assigned to anyone. * A couple of good places to start are issues with the `Status: Help Wanted` or `Type: Good First Issue` labels. You can filter the issues list to only show ones with these (or any) specific labels to make them easier to find. + * You can also filter out any issues with the `Status: In Progress` label, so that you only see issues that haven't been assigned to anyone. 2) Ask to be assigned the issue by a maintainer. * **If you are not a maintainer, do not give others permission to work on an issue** From 187d12dabacd41aee912570c7a10b820526aa26c Mon Sep 17 00:00:00 2001 From: thatblindgeye Date: Tue, 1 Feb 2022 17:27:08 -0500 Subject: [PATCH 27/27] Rearrange repo instructions section --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 702ea54..27fb727 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,16 +81,16 @@ Regardless of the complexity of a change, when you wish to make a contribution o ### Repo Specific Instructions -#### [TOP Website Repo](https://github.com/TheOdinProject/theodinproject) - -Before starting any work on our main website repo, you must read and follow the instructions found on [The Odin Project Wiki](https://github.com/TheOdinProject/theodinproject/wiki). These instructions will help you get the TOP app running locally, and help you with adding new paths, courses, sections, and lessons. - #### [TOP Curriculum Repo](https://github.com/TheOdinProject/curriculum) When submitting a PR for a new lesson, or when you are making significant changes to an existing lesson, you must follow our [Layout Style Guide](https://github.com/TheOdinProject/curriculum/blob/main/LAYOUT_STYLE_GUIDE.md). This helps ensure the layout and formatting is consistent across all of our lessons. If you're new to contributing to open-source, or if you just want to make a really quick PR, you can click the "Improve this lesson on GitHub" link found at the end of each lesson instead of going through the steps to fork + clone one of our repos. +#### [TOP Website Repo](https://github.com/TheOdinProject/theodinproject) + +Before starting any work on our main website repo, you must read and follow the instructions found on [The Odin Project Wiki](https://github.com/TheOdinProject/theodinproject/wiki). These instructions will help you get the TOP app running locally, and help you with adding new paths, courses, sections, and lessons. + ### Check Before Doing Anything It's important that you look through any open issues or PRs in a repo before attempting to submit a new issue or work on a change, regardless of the complexity. This will help avoid any duplicates from being made, as well as prevent more than one person working on the same thing at the same time.