Skip to content

Commit f30e030

Browse files
committed
2 parents 2c0a075 + a5e9d5d commit f30e030

File tree

2 files changed

+38
-3
lines changed

2 files changed

+38
-3
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Getting Started
4+
5+
1. Feel free to open an issue if you wish to propose something new.
6+
2. Fork the repository on GitHub.
7+
3. Clone the fork
8+
9+
## Making Changes
10+
11+
* Create a branch : `git checkout -b branch-name`. Please avoid working directly on the `master` branch.
12+
* Make commits of logical units.
13+
* Make changes in `repositories.json` file only.
14+
* Put this `json object` anywhere in between the other repositories listed in the file **but please do not add it at the start or end of the list.**
15+
16+
17+
```json
18+
{
19+
"name": "repo-name",
20+
"link": "repo-link",
21+
"labels": ["issue-label1", "issue-label2"]
22+
},
23+
```
24+
* Make sure your commit messages are in the proper format.
25+
26+
## Submitting Changes
27+
28+
* Push your changes to the branch in your fork of the repository.
29+
* Submit a pull request to the repository.
30+
* The contributors look at Pull Requests and review them on a regular basis.
31+
* Upon merging of your pull request, `Readme.md` will be automatically updated listing the beginners-friendly repository added by you.

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@
2020
<a href="https://github.com/BitByte-TPC/beginners-byte/blob/master/LICENSE"><img src="https://img.shields.io/github/license/BitByte-TPC/beginners-byte?color=2b9348" alt="License Badge"/></a>
2121
</div>
2222

23-
### Description here
23+
### This repository contains a curated list of awesome beginner-friendly projects :tada: and issue labels where you can easily contribute and get a head start into your journey of Open Source. :rocket:
24+
25+
If you are in search of some good beginner-friendly issues irrespective of the project, head up to [first-timers-only](https://github.com/search?q=label%3Afirst-timers-only+is%3Aissue+is%3Aopen&type=Issues) where you can find all the issues with `first-timer-only` label across all repositories on GitHub.
26+
27+
---
28+
29+
## Projects
2430

25-
| Repository | Issues |
26-
|---|---|
2731
- [10-Easy-Steps](https://github.com/msandfor/10-Easy-Steps)
2832
A Repository Created for #Hacktoberfest to Help Beginners Get Started with Code
2933
[![GitHub issues](https://img.shields.io/github/issues/msandfor/10-Easy-Steps?color=pink&logo=github)](https://github.com/msandfor/10-Easy-Steps/issues)

0 commit comments

Comments
 (0)