Added the file name

sreevidya-16 · Sep 25, 2023 · 24f33bb · 24f33bb
1 parent a2c6e6f
commit 24f33bb
Show file tree

Hide file tree

Showing 9 changed files with 52 additions and 22 deletions.
diff --git a/.github/ISSUE_TEMPLATE/api_enhancement.yaml b/.github/ISSUE_TEMPLATE/api_enhancement.yaml
@@ -27,9 +27,9 @@ body:
     id : terms-conditions
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md)
+      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md)
       options:
-        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md) of this project.
+        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md) of this project.
           required: true
 
 

diff --git a/.github/ISSUE_TEMPLATE/create_new_api.yaml b/.github/ISSUE_TEMPLATE/create_new_api.yaml
@@ -46,9 +46,9 @@ body:
     id : terms-conditions
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md)
+      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md)
       options:
-        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md) of this project.
+        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md) of this project.
           required: true
 
 

diff --git a/.github/ISSUE_TEMPLATE/documentation_error.yaml b/.github/ISSUE_TEMPLATE/documentation_error.yaml
@@ -27,9 +27,9 @@ body:
     id : terms-conditions
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md)
+      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md)
       options:
-        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md) of this project.
+        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md) of this project.
           required: true
 
 

diff --git a/.github/ISSUE_TEMPLATE/use_already_existing_api.yml b/.github/ISSUE_TEMPLATE/use_already_existing_api.yml
@@ -36,9 +36,9 @@ body:
     id : terms-conditions
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md)
+      description: By submitting this issue, you agree to our [CONTRIBUTING GUIDELINES.](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md)
       options:
-        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md) of this project.
+        - label: I follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md) of this project.
           required: true
 
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,7 +13,7 @@
 - [] I have commented my code, particularly in hard-to-understand areas
 - [] I have created a helpful and easy to understand `README.md`
 - [] I have followed proper file structure.
-- [] I have gone through [CONTRIBUTING GUIDELINES.md](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md).
+- [] I have gone through [CONTRIBUTING GUIDELINES.md](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md).
 
  Thank you for contributing!❤️ 
 

diff --git a/.github/workflows/issue_open_greet.yml b/.github/workflows/issue_open_greet.yml
@@ -16,7 +16,7 @@ jobs:
           script: |
             const { owner, repo, number } = context.issue;
             const commentauthor = context.payload.issue.user.login;
-            const commentBody = `Greetings @${commentauthor}🎀 ! , We are excited to have you dive into another issue with us!🚀\nYour involvement in our project has been invaluable, and we're confident that your skills and insights will help us conquer this challenge😇. This issue represents an exciting opportunity for us to improve and enhance our project, and we are thrilled to have you on board.\n We request you to follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md).\nLooking for your PR soon! \n In case of any issues, you can contact us on [Discord](https://discord.gg/mv4NTzN).❣️`;
+            const commentBody = `Greetings @${commentauthor}🎀 ! , We are excited to have you dive into another issue with us!🚀\nYour involvement in our project has been invaluable, and we're confident that your skills and insights will help us conquer this challenge😇. This issue represents an exciting opportunity for us to improve and enhance our project, and we are thrilled to have you on board.\n We request you to follow [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md).\nLooking for your PR soon! \n In case of any issues, you can contact us on [Discord](https://discord.gg/mv4NTzN).❣️`;
             
             await github.issues.createComment({ owner, repo, issue_number: number, body: commentBody });
             console.log(`Commented on the issue: ${commentBody}.`);

diff --git a/.github/workflows/pr_comment.yml b/.github/workflows/pr_comment.yml
@@ -16,7 +16,7 @@ jobs:
           pullRequestOpened: |
            @{{ author }}, Thank you for creating PR! We will review it super soon. 😇❣️
            As we continue to evolve and innovate, we encourage you to share your ideas, feedback, and code to help us push the boundaries of what's possible in the world of APIs🚀.
-           We hope you have followed [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md).
+           We hope you have followed [CONTRIBUTING GUIDELINES](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md).
            Thank you for being an essential part of our community. Together, we'll keep building amazing things!
            Don’t forget to ⭐ our repository!
            Happy Coding!✨

diff --git a/CONTRIBUTING GUIDELINES.md → CONTRIBUTING.md b/CONTRIBUTING GUIDELINES.md → CONTRIBUTING.md
@@ -1,60 +1,88 @@
 # Contributing Guidelines APIVerse🎯!
+
 Below you will find the process and workflow used to review and merge your changes.
+
 ### Step 0 : Find an issue
+
 - Take a look at the Existing Issues or create your **own** Issues!
 - Wait for the Issue to be assigned to you after which you can start working on it.
 - Note : Every change in this project should/must have an associated issue.
+
 ### Step 1 : Fork the Project
+
 - Fork this Repository. This will create a Local Copy of this Repository on your Github Profile.
-Keep a reference to the original project in `upstream` remote.  
+   Keep a reference to the original project in `upstream` remote.
+
 ```bash
 git clone https://github.com/<your-username>/<repo-name>  
 cd <repo-name>  
 git remote add upstream https://github.com/<upstream-owner>/<repo-name>  
-```  
+
+```
+
 - If you have already forked the project, update your copy before working.
+
 ```bash
 git remote update
 git checkout <branch-name>
 git rebase upstream/<branch-name>
-```  
+
+```
+
 ### Step 2 : Branch
+
 Create a new branch. Use its name to identify the issue your addressing.
+
 ```bash
 # It will create a new branch with name Branch_Name and switch to that branch 
 git checkout -b branch_name
+
 ```
+
 ### Step 3 : Work on the issue assigned
+
 - Work on the issue(s) assigned to you.
 - After you've made changes or made your contribution to the project add changes to the branch you've just created by:
 
-```bash  
+```bash
 # To add all new files to branch Branch_Name  
 git add .  
 
 # To add only a few files to Branch_Name
 git add <some files>
+
 ```
+
 ### Step 4 : Commit
+
 - To commit give a descriptive message for the convenience of reviewer by:
+
 ```bash
 git commit -m "message"  
+
 ```
+
 ### Step 5 : Work Remotely
+
 - When your work is ready and complies with the project conventions, upload your changes to your fork:
 
-```bash  
+```bash
 git push -u origin Branch_Name
+
 ```
+
 ### Step 6 : Pull Request
+
 - Go to your repository in browser and click on compare and pull requests.
-Then add a title and description to your pull request that explains your contribution.  
+   Then add a title and description to your pull request that explains your contribution.
+
 ### Need more help?🤔
+
 You can refer to the following articles on basics of Git and Github and also contact the Project Mentors,
 in case you are stuck:
+
 - [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
 - [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
 - [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
 - [Learn GitHub from Scratch](https://lab.github.com/githubtraining/introduction-to-github)
- <br>
-Let's learn something together!❤️🤝
+   Let's learn something together!❤️🤝
diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![discord](https://img.shields.io/badge/Discord-blue?logo=discord&logoColor=white)](https://discord.gg/mv4NTzN)
-<br>
+
 <table align="center">
     <thead align="center">
         <tr border: 1px;>
@@ -62,20 +62,22 @@
  ✅If you are contributing towards any documentation related bug, you should solve atleast 5 documentation bugs to get your PR merged. <br>
 
 ### Note : For existing API, You should submit the corresponding html and css files also so that we can better visualise how this API can be used within projects. Only submitting JS files won't work.
+
 </b>
 </i>
 </div>
 
- Here you go🚀, Looking towards great contributions from your side!🔥 <br>
+Here you go🚀, Looking towards great contributions from your side!🔥 
 
 Happy Coding!❤️
+
 <div>
 
  </div>
  <h2 align = "center">✨ How to contribute?</h2>
  <div align = "left">
 
-- Go through project [README.md](https://github.com/developer-student-clubs/APIVerse/blob/master/README.md) and [CONTRIBUTING GUIDELINES.md](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING%20GUIDELINES.md) to know about project and related guidelines.
+- Go through project [README.md](https://github.com/developer-student-clubs/APIVerse/blob/master/README.md) and [CONTRIBUTING GUIDELINES.md](https://github.com/developer-student-clubs/APIVerse/blob/master/CONTRIBUTING.md) to know about project and related guidelines.
 - Go through project to know what you can contribute towards it.
 
 * *CREATING ISSUE!*