Skip to content

Commit 90c65a1

Browse files
committed
Adds functionality and docs for linking to repos for first-time contributors
1 parent 654a7d5 commit 90c65a1

File tree

4 files changed

+54
-76
lines changed

4 files changed

+54
-76
lines changed

.github/CONTRIBUTING.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,12 @@ If you know of any sites that are not already listed, which you think could be h
4242

4343
Keep in mind - I would ideally like to keep the resources list short, with only the best tools and websites listed, so if you're adding something ensure it meets this criteria, and provide justification.
4444

45+
### Repos for First-Time Contributors
46+
47+
There's a section on our website<sup>[here](https://www.git-in.to/find-projects)</sup>, and within the readme<sup>[here](https://github.com/Lissy93/git-into-open-source#finding-projects)</sup> that links to repositories that are welcoming to first-time contributors.
48+
49+
If you know of a project that you think should be included here, you can add it by editing [`resources.yml`](https://github.com/Lissy93/git-into-open-source/blob/main/resources.yml), appending the repo to the `projects` section.
50+
4551
### Website
4652

4753
We've also got a simple static site, that makes it easier to read some of the guides; it's hosted on GitHub Pages, at [lissy93.github.io/git-into-open-source](https://lissy93.github.io/git-into-open-source/)
@@ -118,7 +124,9 @@ Top tips for adding a great response:
118124
- **Markdown is supported!** So you can include links and basic formatting
119125
- Feel free to link to your projects, website or helpful (SFW) resources
120126
- Hyperlinks (`[text to display](https://example.com)`), new lines (`<br />`) as well as `**bold**` and `_italic_` all work
121-
- **Get a gold star by your name!** Drop a star on this repo, and you'll automatically get a star next to your response
127+
- **Get a gold star by your name!** The script will add some extra flair to your response, if you meet the following criteria:
128+
- Drop a star on this repo, and you'll automatically get a star next to your response!
129+
- Your personal website / X.com profile will be automatically included, if you've included it on your GH profile
122130

123131
When adding a resource to [`resources.yml`](https://github.com/Lissy93/git-into-open-source/blob/main/resources.yml),
124132
you must:
@@ -127,6 +135,16 @@ you must:
127135
- Disclose any association you may have to that website
128136
- Provide a short sentence of justification in your PR, explaining why it should be included
129137

138+
When adding a repo to `projects` in [`resources.yml`](https://github.com/Lissy93/git-into-open-source/blob/main/resources.yml),
139+
the repository you are adding must:
140+
- Be welcoming to first-time contributors
141+
- Have clear documentation for development and contributing
142+
- Be a "useful" project, code-based, with real-world use-cases
143+
- Be actively maintained
144+
- Be at least 3 months old
145+
- Have at least 10 prior contributors
146+
- Have a minimum of 100 stars or 50 forks
147+
130148
When submitting additions or changes to the guides in [`guides/`](https://github.com/Lissy93/git-into-open-source/tree/main/guides),
131149
you must:
132150
- Ensure all new information is, to the best of your knowledge accurate and correct

0 commit comments

Comments
 (0)