✨Contribute 101

A simple project aimed to help new developers make their first open source contribution.

Important

Please keep in mind that pull requests on this project won't count towards Hacktoberfest.
This project is just to help and encourage new developers to get familiar with open source contribution.

GOAL

• Make an successful Open Source contribution.
• Get familiar with GitHub and Git workflow.
• Make a proper PR (Pull Request) and get it accepted and merged by the project maintainer (@rocktimsaikia)

STEPS

1. Fork and Clone the repository

Fork the repository first and then run the below command after forking the repository.
And replace <YOUR_GITHUB_USERNAME> with your GitHub username.
This will clone the repository to your local machine.

git clone https://github.com/<YOUR_GITHUB_USERNAME>/contribute-101.git

2. Setup local branch

You can name it anything you want. Here we are calling it my-card.

# Create a new branch
git checkout -b "my-card"

# Install all requried dependencies
npm install

3. Make the required changes

Now go to src/contributors.js file and add your details at the end of the file.
Please make sure to fill all the fields. Else the pull request will not be accepted.

4. Format your code.

Run these two command to format and fix the code.
It will automatically fix the lint errors if any.

npm run lint:fix
npm run format:fix

5. Push your new changess

# Add all the changes
git add .

# Commit your changes with a message
git commit -m "Add YOURNAME's card"

# Push your changes to your fork
git push -u origin myCard

6. Now create the pull request. Figure this one out yourself 👏

Note

Once you created the PR. It will be reviewed by the project maintainer. Now wait for the PR to be accepted.