Skip to content

contributing.md

Latest commit

 

History

History
161 lines (111 loc) · 5.5 KB

contributing.md

File metadata and controls

161 lines (111 loc) · 5.5 KB

Follow these steps to contribute📈

Understand the Project:

Familiarize yourself with the project's objectives, architecture, and existing codebase. This will enable you to make informed contributions that align with the project's goals.

Choose an Issue/Create an issue:

Create an issue or work on the existing issue if you're assigned. Also, if you're in GSSOC'23, please add "I'm in GSSOC'23" so that we can add the GSSOC'23 label on that particular issue/PR.

Assign an Issue Number:

Assign the #ISSUE_NUMBER in the description of the PR request.

Work on Your assigned issue first:

We kindly request that you prioritize working on your assigned issue at this time. It is highly recommended that you begin by creating an issue before proceeding to create a pull request. By doing so, you can outline the problem or task at hand and facilitate a smoother workflow. Once the issue is established, please proceed to implement the necessary changes, address any bugs, or incorporate new features to effectively resolve the selected issue/task.

Commit Your Changes:

Once you have made significant progress or completed your contribution, commit your changes with a descriptive commit message. It is advisable to make frequent, small commits to make the review process more manageable. Please check conventional commits

DO NOT SPAM !!! ⚠

If the manatainer or owner finds any blank issue or any kind of unethical behaviour from a certain individual, that particular person will labeled as SPAM and will be prohibited from any kind of contribution or participation in future in this project.

😎 How to add your projects to ProjectsHut

  1. Fork this repository

Fork this repository

  1. Click on Go to file

Go to file

  1. Add following code to end of src/DB/projects.json
{
  "github_username": "YOUR_GITHUB_USERNAME",
  "Social_media": {
    "gitHub": "YOUR_GITHUB_ACCOUNT_LINK",
    "LinkedIn": "YOUR_LINKEDIN_ACCOUNT_LINK",
    "Instagram": "YOUR_INSTAGRAM_ACCOUNT_LINK",
    "YouTube": "YOUR_YOUTUBE_ACCOUNT_LINK",
    "Twitter": "YOUR_TWITTER_ACCOUNT_LINK"
  },
  "Projects": [
    {
      "link": "PROJECT_LINK",
      "title": "PROJECT_NAME",
      "description": "PROJECT_DESCRIPTION",
      "tech": ["tech1", "tech2"]
    },
    {
      "link": "PROJECT_LINK",
      "title": "PROJECT_NAME",
      "description": "PROJECT_DESCRIPTION",
      "tech": ["tech1", "tech2"]
    }
  ]
}
  • You should write the tech full name

    js 👎 javascript 👎 JavaScript 👍 css 👎 CSS 👍

in short, you can write your tech on Google and copy from there so we can have common naming conventions
  1. Commit all changes.
  • Add a commit like this for only projects addition data: project addition by [your-githubuser-name] #issue_number

Alternatively, if you prefer to run the project locally, follow these steps:

  1. Go to preferred folder in your computer and paste the following command (Only one of it if you don't have ssh setup then go with HTTP command)
  • HTTP git clone https://github.com/<YOUR-USERNAME>/ProjectsHut.git
  • SSH git clone [email protected]:<YOUR-USERNAME>/ProjectsHut.git
  1. Navigate to the project folder
cd ProjectsHut

  1. Create .env file to the root folder & copy code from .env.example & add your GitHub Personal Access Token in .env file

  2. Install dependencies

pnpm i
  1. Now do ahead and create a new branch and move to the branch
git checkout -b fix-issue-<ISSUE-NUMBER>
  1. Run in local
pnpm dev
  1. Make sure all the test cases pass
pnpm test

  1. After done you can now push this changes, for doing that follow the following command chain

    • git status (Shows the changed files)
    • git add . (Will add all the files to staging area)
    • git commit -m "feat/docs/fix: :emoji-name: <EXPLAIN-YOUR_CHANGES>"

    • If you encounter this error while commits

      husky - pre-commit hook exited with code 1(error)

      use this command

      pnpm format
    • git remote add upstream https://github.com/priyankarpal/ProjectsHut.git
    • git push origin fix-issue-<ISSUE-NUMBER>

  2. After this go to your forked GitHub repository and go to Pull Request section. Now you might be able to see a pop up saying Pull Request. Click on the popup and you will be redirected to pull request page

  3. Now fill in the form template of the pull request and give necessary description.

  4. Click on Submit

  5. Hurrey! You just did your contribution to this project 🎉

  6. Wait for your pull request to be reviewed and merged.

NOTE: Please make sure to follow the Code of conduct while contributing.

Useful Links