https://github.com/RocktimSaikia/Contribute-101
✨ A simple project to get you started with your first open source contribution.
https://github.com/RocktimSaikia/Contribute-101
first-timers good-first-issue
Last synced: 5 months ago
JSON representation
✨ A simple project to get you started with your first open source contribution.
- Host: GitHub
- URL: https://github.com/RocktimSaikia/Contribute-101
- Owner: rocktimsaikia
- License: mit
- Created: 2018-11-02T10:45:18.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2025-04-27T07:54:43.000Z (6 months ago)
- Last Synced: 2025-05-04T00:36:12.157Z (6 months ago)
- Topics: first-timers, good-first-issue
- Language: JavaScript
- Homepage: https://rocktimsaikia.dev/contribute-101
- Size: 3.66 MB
- Stars: 53
- Watchers: 2
- Forks: 186
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨Contribute 101
A simple project aimed to help new developers make their first open source contribution.
[](https://github.com/rocktimsaikia/contribute-101/actions/workflows/tests.yml) [](https://app.netlify.com/sites/contribute-101/deploys)
> [!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 `` with your GitHub username. \
This will clone the repository to your local machine.
```bash
git clone https://github.com//contribute-101.git
```
### 2. Setup local branch
You can name it anything you want. Here we are calling it `my-card`.
```bash
# 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.
```bash
npm run lint:fix
npm run format:fix
```
### 5. Push your new changess
```bash
# 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.