Merge pull request #339 from Asartea/chore/update-contributing-links
Chore: repoint contributing links to .github/CONTRIBUTING.md
This commit is contained in:
commit
5bfacdc286
|
@ -9,7 +9,7 @@ assignees: ""
|
||||||
<!-- Thank you for taking the time to submit a bug report to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the bug in question. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
|
<!-- Thank you for taking the time to submit a bug report to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the bug in question. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
|
||||||
|
|
||||||
Complete the following REQUIRED checkboxes:
|
Complete the following REQUIRED checkboxes:
|
||||||
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
|
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md)
|
||||||
- [ ] The title of this issue follows the `Bug - location of bug: brief description of bug` format, e.g. `Bug - Grid exercises: CSS not properly linked to HTML files`
|
- [ ] The title of this issue follows the `Bug - location of bug: brief description of bug` format, e.g. `Bug - Grid exercises: CSS not properly linked to HTML files`
|
||||||
|
|
||||||
The following checkbox is OPTIONAL:
|
The following checkbox is OPTIONAL:
|
||||||
|
|
|
@ -9,7 +9,7 @@ assignees: ""
|
||||||
<!-- Thank you for taking the time to submit a new feature request to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the feature/enhancement you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
|
<!-- Thank you for taking the time to submit a new feature request to The Odin Project. In order to get issues closed in a reasonable amount of time, you must include a baseline of information about the feature/enhancement you are proposing. Please read this template in its entirety before filling it out to ensure that it is filled out correctly. -->
|
||||||
|
|
||||||
Complete the following REQUIRED checkboxes:
|
Complete the following REQUIRED checkboxes:
|
||||||
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
|
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md)
|
||||||
- [ ] The title of this issue follows the `location for request: brief description of request` format, e.g. `Foundations exercises: Add exercise for XYZ`
|
- [ ] The title of this issue follows the `location for request: brief description of request` format, e.g. `Foundations exercises: Add exercise for XYZ`
|
||||||
|
|
||||||
The following checkbox is OPTIONAL:
|
The following checkbox is OPTIONAL:
|
||||||
|
@ -19,8 +19,8 @@ The following checkbox is OPTIONAL:
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
**1. Description of the Feature Request:**
|
**1. Description of the Feature Request:**
|
||||||
<!--
|
<!--
|
||||||
A clear and concise description of what the feature or enhancement is, including how it would be useful/beneficial or what problem(s) it would solve.
|
A clear and concise description of what the feature or enhancement is, including how it would be useful/beneficial or what problem(s) it would solve.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ Closes #XXXXX
|
||||||
|
|
||||||
## Pull Request Requirements
|
## Pull Request Requirements
|
||||||
<!-- Replace the whitespace between the square brackets with an 'x', e.g. [x]. After you create the PR, they will become checkboxes that you can click on. -->
|
<!-- Replace the whitespace between the square brackets with an 'x', e.g. [x]. After you create the PR, they will become checkboxes that you can click on. -->
|
||||||
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md)
|
- [ ] I have thoroughly read and understand [The Odin Project Contributing Guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md)
|
||||||
- [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `01-flex-center: Update self check`
|
- [ ] The title of this PR follows the `location of change: brief description of change` format, e.g. `01-flex-center: Update self check`
|
||||||
- [ ] The `Because` section summarizes the reason for this PR
|
- [ ] The `Because` section summarizes the reason for this PR
|
||||||
- [ ] The `This PR` section has a bullet point list describing the changes in this PR
|
- [ ] The `This PR` section has a bullet point list describing the changes in this PR
|
||||||
|
|
10
README.md
10
README.md
|
@ -6,18 +6,18 @@ When doing these exercises, please use all the documentation and resources you n
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
If you have a suggestion to improve an exercise, an idea for a new exercise, or notice an issue with an exercise, please feel free to open an issue after thoroughly reading our [contributing guide](https://github.com/TheOdinProject/theodinproject/blob/main/CONTRIBUTING.md) in our main TOP repo.
|
If you have a suggestion to improve an exercise, an idea for a new exercise, or notice an issue with an exercise, please feel free to open an issue after thoroughly reading our [contributing guide](https://github.com/TheOdinProject/.github/blob/main/CONTRIBUTING.md).
|
||||||
|
|
||||||
## How To Use These Exercises
|
## How To Use These Exercises
|
||||||
|
|
||||||
1. Fork and clone this repository. To learn how to fork a repository, see the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
|
1. Fork and clone this repository. To learn how to fork a repository, see the GitHub documentation on how to [fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
|
||||||
* Copies of repositories on your machine are called clones. If you need help cloning to your local environment you can learn how from the GitHub documentation on [cloning a repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository).
|
* Copies of repositories on your machine are called clones. If you need help cloning to your local environment you can learn how from the GitHub documentation on [cloning a repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository).
|
||||||
2. Go to an exercise directory and open the HTML file in your browser. You can either open the file directly, or use something like VSCode's Live Server extension.
|
2. Go to an exercise directory and open the HTML file in your browser. You can either open the file directly, or use something like VSCode's Live Server extension.
|
||||||
3. For each exercise, read the README thoroughly before starting any work.
|
3. For each exercise, read the README thoroughly before starting any work.
|
||||||
* Each README has a "Self Check" list. Use this to make sure you haven't missed any important details in your implementation.
|
* Each README has a "Self Check" list. Use this to make sure you haven't missed any important details in your implementation.
|
||||||
4. Make your edits in the `index.html` and/or the `style.css` files in order to make the output in your browser look like the Desired Outcome image(s).
|
4. Make your edits in the `index.html` and/or the `style.css` files in order to make the output in your browser look like the Desired Outcome image(s).
|
||||||
* Depending on the instructions of the exercise, you may only need to make edits in one of these files.
|
* Depending on the instructions of the exercise, you may only need to make edits in one of these files.
|
||||||
5. Once you successfully finish an exercise, check TOP's solution to compare it with yours.
|
5. Once you successfully finish an exercise, check TOP's solution to compare it with yours.
|
||||||
* You should not be checking the solution for an exercise until you finish it!
|
* You should not be checking the solution for an exercise until you finish it!
|
||||||
* Keep in mind that TOP's solution is not the only solution. If your solution differs wildly from TOP's solution (and still passes the self-check criteria), feel free to ask about it in the chatroom.
|
* Keep in mind that TOP's solution is not the only solution. If your solution differs wildly from TOP's solution (and still passes the self-check criteria), feel free to ask about it in the chatroom.
|
||||||
6. Do not submit your solutions to this repo, as any PRs that do so will be closed without merging.
|
6. Do not submit your solutions to this repo, as any PRs that do so will be closed without merging.
|
||||||
|
|
Loading…
Reference in New Issue