Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 2 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
- Archived: true
- Created: 2018-11-02T10:45:18.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-09T15:22:56.000Z (about 2 years ago)
- Last Synced: 2024-08-04T07:02:53.741Z (5 months ago)
- Topics: first-timers, good-first-issue
- Language: JavaScript
- Homepage: https://contribute101.herokuapp.com
- Size: 3.66 MB
- Stars: 47
- Watchers: 2
- Forks: 185
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
✨Contribute101
✨ A simple project to help people make their first open source pull request
> 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.
## :cloud: Introduction:
Hello Contributors!
Open Source projects are a great way for enhancing your coding skills and exploring new technologies.
But top of that contributing to Open Source Projects is FUN.
The joy of the first time when your pull request gets accepted is amazing. Which you are going to find today by contributing to this project.
## :star: Aim:
- To make an Open Source contribution.
- To use GitHub and Git.
- Get familiar with NodeJs.
- Make a Pull Request.
## :grey_question: Who Can Contribute?
Anyone from an absolute beginner to a developer can contribute to enhance your open source experience.
## :green_heart: NodeJs:
Node.js is a run-time environment which includes everything you need to execute a program written in JavaScript. It’s used for running scripts on the server to render content before it is delivered to a web browser.
NPM stands for Node Package Manager, which is an application and repository for developing and sharing JavaScript code.
## :hammer: Prerequisite :
- Setup your GitHub account. To familiarize with GitHub go through [GitHub Hello World Guide](https://guides.github.com/activities/hello-world/)
- You can download [GitHub Desktop App](https://desktop.github.com/) or use Git on command line.
- Install [nodejs](https://nodejs.org) on your local machine globally. Click [here](https://phoenixnap.com/kb/install-node-js-npm-on-windows) for more information.
## :sparkles: Steps :
1. Fork this repository and clone it to your computer.
2. Install the dependencies locally
```bash
npm install
```
3. Now create a new remote branch with any name you want
```bash
git checkout -b "myCard"
```
4. Now go to `contributors/index.js` file and add your details.
5. Run this command to check for any remaining typos and style errors
```bash
npm run lint:fix
```
5. Push your local changes that you have made
```bash
git add .
git commit -m "Add YOURNAME's card"
git push -u origin myCard
```
6. Now create the pull request
Your changes would not be visible immediately.
Your pull request will be reviewed, get accepted and merged by the project maintainer.
You can now celebrate ! :confetti_ball:
### Congrats :tada: .You have successfully created your pull request. Now wait for PR to be reviewed and get merged!