From 32198b47f240f86676fc8e8f9203b49d8f0d340a Mon Sep 17 00:00:00 2001 From: Rahul Karda Date: Tue, 14 Jun 2022 12:31:57 +0530 Subject: [PATCH 1/9] Add Pull Requests badge --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c6da429..e2238ba 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ [![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] +[![Pull Requests][pullrequests-shield]][pullrequests-url] [![Issues][issues-shield]][issues-url] [![MIT License][license-shield]][license-url] @@ -148,6 +149,8 @@ Distributed under the MIT License. See `) +4. If you are adding a resource, please skip to step 6. +5. Create a new branch for your Feature (`git branch AmazingFeature`) +6. Switch to the branch you are working on (`git checkout AmazingFeature`) +7. Make your changes, commit after every isolated task. +8. Add all of your changes (`git add .`) +9. Commit your changes with a detailed description (`git commit -m 'added a, solved b, etc...'`) +10. Push to the Branch (`git push origin AmazingFeature`) +11. Open a Pull Request and follow the rules under "Where should I make my pull request to?" From 203c78363e8280a8ba315ad6a08d9e169cfd0403 Mon Sep 17 00:00:00 2001 From: Brian Schnee <77141303+brianschnee@users.noreply.github.com> Date: Tue, 14 Jun 2022 18:52:59 -0400 Subject: [PATCH 3/9] Update README.md --- README.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/README.md b/README.md index e2238ba..665778b 100644 --- a/README.md +++ b/README.md @@ -104,15 +104,7 @@ See the [open issues](https://github.com/the-api-administration/coding-resources Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. -If you have a suggestion to better our API, please fork the repo and create a pull request. Additionally, you can open an issue and offer advice. -Don't forget to give the project a star! Thanks again! - -1. Visit our Issues page to check if an issue exists and does not have an assignee. -2. Fork the Project -3. Change to your Feature Branch (`git checkout -b feature/AmazingFeature`) -4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) -5. Push to the Branch (`git push origin feature/AmazingFeature`) -6. Open a Pull Request +Please visit: https://github.com/the-api-administration/coding-resources-api/blob/main/CONTRIBUTING.md before making a contribution to our project. Thank you!

(back to top)

From 40d5eccc6544cd9a8a794e026201613bd5b8ea89 Mon Sep 17 00:00:00 2001 From: Brian Schnee <77141303+brianschnee@users.noreply.github.com> Date: Tue, 14 Jun 2022 18:56:54 -0400 Subject: [PATCH 4/9] Updated README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 665778b..7cadc5a 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ See the [open issues](https://github.com/the-api-administration/coding-resources Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. -Please visit: https://github.com/the-api-administration/coding-resources-api/blob/main/CONTRIBUTING.md before making a contribution to our project. Thank you! +Please visit `CONTRIBUTING.md` to read about our guidelines before making a contribution to our project. Thank you!

(back to top)

From 16c6e08c9c97be2e5167ce9d0e0bc33a9261709d Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Tue, 14 Jun 2022 19:04:12 -0400 Subject: [PATCH 5/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0adb945..1cbf0dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,18 +9,18 @@ Contributions are what make the open source community such an amazing place to l ## Understanding Coding-Resources-API branch structure -### Permanent Branches -#### Main +## Permanent Branches +## Main - This branch is reserved for tested versions of our code-base. Do not make a PR directly into this branch, as we require testing before we can confirm any feature. -#### Test -- This branch is used to test a collection of newly added features, which will eventually become a future iteration of our application after thoroughly testing for bugs and code/guideline consistency. If you are interesting in creating your own feature, we suggest that you first open an issue here: https://github.com/the-api-administration/coding-resources-api/issues and wait for our team to respond to your message and approve the implementation. If you are interested in taking responsibility for the implementation, please assign yourself to the issue once you submit it, so that our team can note your interest. +## Test +- This branch is used to test a collection of newly added features, which will eventually become a future iteration of our application after thoroughly testing for bugs and code/guideline consistency. If you are interested in creating your own feature, we suggest that you first open an issue here: https://github.com/the-api-administration/coding-resources-api/issues and wait for our team to respond to your message and approve the implementation. If you are interested in taking responsibility for the implementation, please assign yourself to the issue once you submit it, so that our team can note your interest. -#### Resources +## Resources - This branch is reserved for adding new resources to our resources.js file. When adding a resource, follow these styling guidelines or we will be unable to address your contribution. Resource Addition Guidelines: @@ -47,27 +47,27 @@ Contributions are what make the open source community such an amazing place to l -### How often should I stage changes? +## How often should I stage changes? We require that you stage your changes for each section of code you develop. Do not stage changes with a single large commit, or we will instantly close your pull request. We would like you to make commits for every task you complete in your code and avoid working through multiple files when possible. Your commit message should include a detailed view of the work you are implementing and an issue you are solving if you have assigned yourself to an issue. -### Where should I make my pull request to? +## Where should I make my pull request to? -Never make a pull request into our main branch. If you plan on adding a feature, wait until you have completely finished that feature and then make a pull request into "test" with a clear description of the issue you are solving. If you are planning on adding a resource, please make a pull request to that branch. +Never make a pull request into our main branch. If you plan on adding a feature, wait until you have completely finished that feature and then make a pull request into "test" with a clear description of the issue you are solving. If you are planning on adding a resource, please make a pull request to the resources branch. -### Creating an Issue +## Creating an Issue -We'd love to hear your advice, feature suggestions and/or read about any bugs you've encountered. Please create an issue here: https://github.com/the-api-administration/coding-resources-api/issues. If you wish to implement a feature on your own, please add yourself as an assignee to the issue you create, so that we can note your interest. When creating an issue, please attempt to outline in detail; the topic of the issue, and a thorough description of what the issue attempts to solve. +We'd love to hear your advice, feature suggestions and/or read about any bugs you've encountered. Please create an issue here: https://github.com/the-api-administration/coding-resources-api/issues. If you wish to implement a feature on your own, please add yourself as an assignee to the issue you create, so that we can note your interest. When creating an issue, please attempt to outline in detail the topic of the issue, and a thorough description of what the issue attempts to solve. -If you have encountered a bug, please provide as much information as you can to help us replicate the issue on our own end. Depending on the issue, it may be useful to communicate your browser, screen width and/or anything that relates to your specific encounter. +If you have encountered a bug, please provide as much information as you can to help us replicate the issue on our own end. Depending on the issue, it may be useful to communicate your browser, screen width, and/or anything that relates to your specific encounter. -### How to make a PR +## How to make a PR If you want to help us improve our API, please fork the repo and follow these steps before creating a pull request. From 0a3fc6f1945c8574f6c1ca1fe4f99a38f6d9e833 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Tue, 14 Jun 2022 19:04:35 -0400 Subject: [PATCH 6/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cbf0dc..11206f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Contributions are what make the open source community such an amazing place to l ## Understanding Coding-Resources-API branch structure ## Permanent Branches -## Main +### Main - This branch is reserved for tested versions of our code-base. Do not make a PR directly into this branch, as we require testing before we can confirm any feature. From 27c9a852dbde9dffe30c1d89223f8898f92928e8 Mon Sep 17 00:00:00 2001 From: Alexis Aguilar <98043211+alexisintech@users.noreply.github.com> Date: Tue, 14 Jun 2022 19:05:12 -0400 Subject: [PATCH 7/9] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 11206f9..1cbf0dc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,7 @@ Contributions are what make the open source community such an amazing place to l ## Understanding Coding-Resources-API branch structure ## Permanent Branches -### Main +## Main - This branch is reserved for tested versions of our code-base. Do not make a PR directly into this branch, as we require testing before we can confirm any feature. From bb0ee65eda9d67a71bc3db963a2f0ea869de488a Mon Sep 17 00:00:00 2001 From: Brian Schnee <77141303+brianschnee@users.noreply.github.com> Date: Tue, 14 Jun 2022 19:06:42 -0400 Subject: [PATCH 8/9] Updated CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1cbf0dc..b453829 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,18 +9,18 @@ Contributions are what make the open source community such an amazing place to l ## Understanding Coding-Resources-API branch structure -## Permanent Branches -## Main +### Permanent Branches +#### Main - This branch is reserved for tested versions of our code-base. Do not make a PR directly into this branch, as we require testing before we can confirm any feature. -## Test +#### Test - This branch is used to test a collection of newly added features, which will eventually become a future iteration of our application after thoroughly testing for bugs and code/guideline consistency. If you are interested in creating your own feature, we suggest that you first open an issue here: https://github.com/the-api-administration/coding-resources-api/issues and wait for our team to respond to your message and approve the implementation. If you are interested in taking responsibility for the implementation, please assign yourself to the issue once you submit it, so that our team can note your interest. -## Resources +#### Resources - This branch is reserved for adding new resources to our resources.js file. When adding a resource, follow these styling guidelines or we will be unable to address your contribution. Resource Addition Guidelines: From c866f2eea271860a83c4fab55209c069c3177e3f Mon Sep 17 00:00:00 2001 From: Lucas Winkler Date: Thu, 16 Jun 2022 20:09:10 -0500 Subject: [PATCH 9/9] changed sentence order for issue #77. --- views/index.ejs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/views/index.ejs b/views/index.ejs index 49d1311..c71bb76 100644 --- a/views/index.ejs +++ b/views/index.ejs @@ -33,10 +33,10 @@

Coding Resources API

- Search for coding resources by relevant keywords. - This API serves educational content for a wide + Serves educational content for a wide variety of computer science topics, languages and technologies relevant to web development. + Search for coding resources by relevant keywords.