From 6895026d271c87b6558ee88d41eab26d4948a3c9 Mon Sep 17 00:00:00 2001 From: Radhika Malpani Date: Sat, 13 Jul 2024 16:59:35 +0530 Subject: [PATCH 1/5] create contribute contribute.tsx --- src/components/shared/contribute.tsx | 127 +++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 src/components/shared/contribute.tsx diff --git a/src/components/shared/contribute.tsx b/src/components/shared/contribute.tsx new file mode 100644 index 0000000..76dcda3 --- /dev/null +++ b/src/components/shared/contribute.tsx @@ -0,0 +1,127 @@ +import React from "react"; + +const ContributingGuidelines = () => { + return ( +
+
+

+ Contributing Guidelines +

+

+ This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small. +

+

+ Please note we have a code of conduct please follow it in all your interactions with the project. +

+ +

+ Need some help regarding the basics? +

+

+ You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: +

+ + +

+ Steps to Contribute +

+
    +
  1. Fork this repository.
    2. +
  2. Clone your forked copy of the project.
    3. + 
    +            git clone https://github.com/<your_user_name>/BloxAI.git
+
    +
  3. Navigate to the project directory.
    4. + 
    +            cd BloxAI.git
+
    +
  4. Add a reference(remote) to the original repository.
    5. + 
    +            git remote add upstream https://github.com/subhadeeproy3902/BloxAI.git
+
    +
  5. Check the remotes for this repository.
    6. + 
    +            git remote -v
+
    +
  6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).
    7. + 
    +            git pull upstream main
+
    +
  7. Create a new branch.
    8. + 
    +            git checkout -b <your_branch_name>
+
    +
  8. Perform your desired changes to the code base.
    9. +
  9. Track your changes.
    10. + 
    +            git add .
+
    +
  10. Commit your changes.
    11. + 
    +            git commit -m "Relevant message"
+
    +
  11. Push the committed changes in your feature branch to your remote repo.
    12. + 
    +            git push -u origin <your_branch_name>
+
    +
  12. To create a pull request, click on `compare and pull requests`.
    13. +
  13. Add appropriate title and description to your pull request explaining your changes and efforts done.
    14. +
  14. Click on `Create Pull Request`.
    15. +
+ +

+ Alternatively contribute using GitHub Desktop +

+
    +
  1. Open GitHub Desktop and log in to your GitHub account if you haven't already.
    2. +
  2. Clone the Repository.
    3. +
  3. Switch to the Correct Branch.
    4. +
  4. Make Changes using your preferred code editor.
    5. +
  5. Commit Changes in GitHub Desktop.
    6. +
  6. Push Changes to GitHub.
    7. +
  7. Create a Pull Request on GitHub.
    8. +
  8. Review and Submit the Pull Request.
    9. +
  9. Wait for Review by the project maintainers.
    10. +
+ +

+ Issue Report Process +

+
    +
  1. Go to the project's issues.
    2. +
  2. Provide a proper description for the issues.
    3. +
  3. Don't spam to get the assignment of the issue.
    4. +
  4. Wait until someone looks into it.
    5. +
  5. Start working on the issue only after you are assigned.
    6. +
+ +

+ Interested contributors and issue raisers are also requested to join our WhatsApp Group for more discussions and faster PR merging. +

+ +

+ Pull Request Process +

+
    +
  1. Ensure that you have self-reviewed your code.
    2. +
  2. Make sure you have added a proper description for the functionality of the code.
    3. +
  3. Comment your code, particularly in hard-to-understand areas.
    4. +
  4. Add screenshots if it helps in the review.
    5. +
  5. Submit your PR by providing the necessary information in the PR template and hang tight; we will review it really soon.
    6. +
+ +

+ Thank you for contributing ! +

+
+
+ ); +}; + +export default ContributingGuidelines; From 90fe88f68001328236c07eac171d8687a1352e09 Mon Sep 17 00:00:00 2001 From: Radhika Malpani Date: Sat, 13 Jul 2024 17:00:08 +0530 Subject: [PATCH 2/5] create page.tsx --- src/app/contribute/page.tsx | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 src/app/contribute/page.tsx diff --git a/src/app/contribute/page.tsx b/src/app/contribute/page.tsx new file mode 100644 index 0000000..dff46ba --- /dev/null +++ b/src/app/contribute/page.tsx @@ -0,0 +1,16 @@ +"use client"; +import ContributingGuidelines from "@/components/shared/contribute"; +import Header from "@/components/shared/Header"; +import Footer from "@/components/shared/Footer"; + +const Page = () => { + return ( +
+
+ +
+
+ ); +}; + +export default Page; From dd38c89a2422009673f3c9d8c35fb36bdbf75b6d Mon Sep 17 00:00:00 2001 From: Radhika Malpani Date: Sat, 13 Jul 2024 17:00:23 +0530 Subject: [PATCH 3/5] update footer.tsx --- src/components/shared/Footer.tsx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/components/shared/Footer.tsx b/src/components/shared/Footer.tsx index 20ddba5..058fc39 100644 --- a/src/components/shared/Footer.tsx +++ b/src/components/shared/Footer.tsx @@ -152,6 +152,12 @@ const Footer: React.FC = () => { Terms & Conditions +
  • + + Contributing Guidelines + +
  • Code Of Conduct From 416c250afa914dd06d40c18408cec2a8c71677b1 Mon Sep 17 00:00:00 2001 From: Radhika Malpani Date: Sat, 13 Jul 2024 17:45:45 +0530 Subject: [PATCH 4/5] update contribute.tsx --- src/components/shared/contribute.tsx | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/src/components/shared/contribute.tsx b/src/components/shared/contribute.tsx index 76dcda3..a61360d 100644 --- a/src/components/shared/contribute.tsx +++ b/src/components/shared/contribute.tsx @@ -5,7 +5,7 @@ const ContributingGuidelines = () => {

    - Contributing Guidelines + Contributing Guidelines

    This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small. @@ -15,7 +15,7 @@ const ContributingGuidelines = () => {

    - Need some help regarding the basics? + Need some help regarding the basics?

    You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: @@ -34,40 +34,40 @@ const ContributingGuidelines = () => {

    1. Fork this repository.
    2. Clone your forked copy of the project.
      3. - 
      +          
                   git clone https://github.com/<your_user_name>/BloxAI.git
           
      
           
    3. Navigate to the project directory.
      4. 
-          
      +          
                   cd BloxAI.git
           
      
           
    4. Add a reference(remote) to the original repository.
      5. 
-          
      +          
                   git remote add upstream https://github.com/subhadeeproy3902/BloxAI.git
           
      
           
    5. Check the remotes for this repository.
      6. 
-          
      +          
                   git remote -v
           
      
           
    6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).
      7. 
-          
      +          
                   git pull upstream main
           
      
           
    7. Create a new branch.
      8. 
-          
      +          
                   git checkout -b <your_branch_name>
           
      
           
    8. Perform your desired changes to the code base.
      9. 
           
    9. Track your changes.
      10. 
-          
      +          
                   git add .
           
      
           
    10. Commit your changes.
      11. 
-          
      +          
                   git commit -m "Relevant message"
           
      
           
    11. Push the committed changes in your feature branch to your remote repo.
      12. 
-          
      +          
                   git push -u origin <your_branch_name>
           
      
           
    12. To create a pull request, click on `compare and pull requests`.
      13. 
@@ -91,7 +91,7 @@ const ContributingGuidelines = () => {

    - Issue Report Process + Issue Report Process

    1. Go to the project's issues.
      2. @@ -106,7 +106,7 @@ const ContributingGuidelines = () => {

      - Pull Request Process + Pull Request Process

      1. Ensure that you have self-reviewed your code.
        2. From 1e203dd91cceb9438b4b3edb30bb214447d33da7 Mon Sep 17 00:00:00 2001 From: Radhika Malpani Date: Wed, 17 Jul 2024 14:26:50 +0530 Subject: [PATCH 5/5] update contribute.tsx --- src/components/shared/contribute.tsx | 216 ++++++++++++++++----------- 1 file changed, 132 insertions(+), 84 deletions(-) diff --git a/src/components/shared/contribute.tsx b/src/components/shared/contribute.tsx index a61360d..2072b99 100644 --- a/src/components/shared/contribute.tsx +++ b/src/components/shared/contribute.tsx @@ -1,127 +1,175 @@ import React from "react"; -const ContributingGuidelines = () => { +const Contributing = () => { return (
        -

        +

        Contributing Guidelines

        - This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small. + This documentation contains a set of guidelines to help you during the contribution process. + We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. + Thank you for helping out and remember, no contribution is too small.

        - Please note we have a code of conduct please follow it in all your interactions with the project. + Please note we have a code of conduct; please follow it in all your interactions with the project.

        - -

        + +

        Need some help regarding the basics?

        - You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: + 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
          • -
        • Cloning a Repo
          • -
        • How to create a Pull Request
          • -
        • Getting started with Git and GitHub
          • -
        • Learn GitHub from Scratch
          • + - -

          - Steps to Contribute + +

          + Contribution Steps

          -
            -
          1. Fork this repository.
            2. -
          2. Clone your forked copy of the project.
            3. - 
            -            git clone https://github.com/<your_user_name>/BloxAI.git
-
            -
          3. Navigate to the project directory.
            4. - 
            -            cd BloxAI.git
-
            -
          4. Add a reference(remote) to the original repository.
            5. - 
            -            git remote add upstream https://github.com/subhadeeproy3902/BloxAI.git
-
            -
          5. Check the remotes for this repository.
            6. - 
            -            git remote -v
-
            -
          6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository).
            7. - 
            -            git pull upstream main
-
            -
          7. Create a new branch.
            8. - 
            -            git checkout -b <your_branch_name>
-
            +
              +
            1. Fork this repository.
              2. +
            2. Clone your forked copy of the project. + 
              git clone https://github.com/<your_user_name>/BloxAI.git
              +
              3. +
            3. Navigate to the project directory. + 
              cd BloxAI.git
              +
              4. +
            4. Add a reference(remote) to the original repository. + 
              git remote add upstream https://github.com/subhadeeproy3902/BloxAI.git
              +
              5. +
            5. Check the remotes for this repository. + 
              git remote -v
              +
              6. +
            6. Always take a pull from the upstream repository to your master branch to keep it at par with the main project (updated repository). + 
              git pull upstream main
              +
              7. +
            7. Create a new branch. + 
              git checkout -b <your_branch_name>
              +
            8. Perform your desired changes to the code base.
              9. -
            9. Track your changes.
              10. - 
              -            git add .
-
              -
            10. Commit your changes.
              11. - 
              -            git commit -m "Relevant message"
-
              -
            11. Push the committed changes in your feature branch to your remote repo.
              12. - 
              -            git push -u origin <your_branch_name>
-
              -
            12. To create a pull request, click on `compare and pull requests`.
              13. +
            13. Track your changes. + 
              git add .
              +
              14. +
            14. Commit your changes. + 
              git commit -m "Relevant message"
              +
              15. +
            15. Push the committed changes in your feature branch to your remote repo. + 
              git push -u origin <your_branch_name>
              +
              16. +
            16. To create a pull request, click on compare and pull requests.
            17. Add appropriate title and description to your pull request explaining your changes and efforts done.
              18. -
            18. Click on `Create Pull Request`.
              19. +
            19. Click on Create Pull Request.
            -

            - Alternatively contribute using GitHub Desktop +

            + Alternatively, Contribute using GitHub Desktop

            -
              -
            1. Open GitHub Desktop and log in to your GitHub account if you haven't already.
              2. -
            2. Clone the Repository.
              3. -
            3. Switch to the Correct Branch.
              4. -
            4. Make Changes using your preferred code editor.
              5. -
            5. Commit Changes in GitHub Desktop.
              6. -
            6. Push Changes to GitHub.
              7. -
            7. Create a Pull Request on GitHub.
              8. -
            8. Review and Submit the Pull Request.
              9. -
            9. Wait for Review by the project maintainers.
              10. +
                +
              1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.
                2. +
              2. Clone the Repository: +
                  +
                • If you haven't cloned the ResourceHub repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
                  • +
                • Choose the ResourceHub repository from the list of repositories on GitHub and clone it to your local machine.
                  • +
                +
                3. +
              3. Switch to the Correct Branch: +
                  +
                • Ensure you are on the branch that you want to submit a pull request for.
                  • +
                • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.
                  • +
                +
                4. +
              4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.
                5. +
              5. Commit Changes: +
                  +
                • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
                  • +
                • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to <branch-name>" button to commit your changes to the local branch.
                  • +
                +
                6. +
              6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.
                7. +
              7. Create a Pull Request: +
                  +
                • Go to the GitHub website and navigate to your fork of the ResourceHub repository.
                  • +
                • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.
                  • +
                +
                8. +
              8. Review and Submit: +
                  +
                • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
                  • +
                • Once you're satisfied, click the "Create pull request" button to submit your pull request.
                  • +
                +
                9. +
              9. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the ResourceHub repository.
              + +

              + Support the Project +

              +

              + If you find this project helpful, please consider giving it a star on GitHub! Your support helps to grow the project and reach more contributors. +

              -

              +

              Issue Report Process

              -
                +
                1. Go to the project's issues.
                  2. -
                2. Provide a proper description for the issues.
                  3. +
                3. Give proper description for the issues.
                4. Don't spam to get the assignment of the issue.
                  5. -
                5. Wait until someone looks into it.
                  6. -
                6. Start working on the issue only after you are assigned.
                  7. +
                7. Wait for till someone is looking into it!
                  8. +
                8. Start working on issue only after you got assigned that issue.
                +

                + Interested contributors and issue raisers are also requested to join WhatsApp Group for more discussions and faster PR merging. +

                +

                + Contributor Details +

                +

                + To ensure transparency and recognition for your contributions, we've established a straightforward process. When resolving issues or submitting PRs, please remember to fill out your details in src/app/contributors/ContributorsData.ts. This file serves as a repository of the individuals who are actively involved in improving our platform. +

                +

                + Add your Name, Image URL and Github link in this file as an object: + + File Location + +

                - Interested contributors and issue raisers are also requested to join our WhatsApp Group for more discussions and faster PR merging. + However, it's important to adhere to strict regulations to maintain the integrity of our contributor records: +

                +
                  +
                • Only Add Your Details: You are allowed to add your own details to the ContributorsData.ts file. This helps us accurately attribute contributions to the right individuals.
                  • +
                • Respect Others' Details: Modifying or tampering with existing contributor details is strictly prohibited. Any unauthorized changes may result in your PR not being merged or accepted.
                  • +
                +

                + We understand that open source collaboration is filled with excitement and fulfillment. Your contributions are invaluable, and we're committed to ensuring that your efforts are duly recognized and appreciated.

                -

                +

                Pull Request Process

                -
                  +
                  1. Ensure that you have self-reviewed your code.
                    2. -
                  2. Make sure you have added a proper description for the functionality of the code.
                    3. -
                  3. Comment your code, particularly in hard-to-understand areas.
                    4. -
                  4. Add screenshots if it helps in the review.
                    5. -
                  5. Submit your PR by providing the necessary information in the PR template and hang tight; we will review it really soon.
                    6. +
                  6. Make sure you have added the proper description for the functionality of the code.
                    7. +
                  7. I have commented my code, particularly in hard-to-understand areas.
                    8. +
                  8. Add screenshot it help in review.
                    9. +
                  9. Submit your PR by giving the necessary information in PR template and hang tight we will review it really soon.
                  -

                  - Thank you for contributing ! -

                  +

                  + Thank you for contributing. +

        ); }; -export default ContributingGuidelines; +export default Contributing;