Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DeepSourceCorp/good-first-issue
Make your first open-source contribution.
https://github.com/DeepSourceCorp/good-first-issue
contributions-welcome good-first-issue open-source
Last synced: 4 months ago
JSON representation
Make your first open-source contribution.
- Host: GitHub
- URL: https://github.com/DeepSourceCorp/good-first-issue
- Owner: DeepSourceCorp
- License: mit
- Created: 2020-01-31T01:57:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T21:45:02.000Z (4 months ago)
- Last Synced: 2024-10-17T12:25:42.810Z (4 months ago)
- Topics: contributions-welcome, good-first-issue, open-source
- Language: Vue
- Homepage: https://goodfirstissue.dev
- Size: 1.31 MB
- Stars: 2,454
- Watchers: 36
- Forks: 746
- Open Issues: 172
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome! 👋🏼
**Good First Issue** is an initiative to curate easy pickings from popular projects, so developers who've never contributed to open-source can get started quickly.
Open-source maintainers are always looking to get more people involved, but new developers generally think it's challenging to become a contributor. We believe getting developers to fix super-easy issues removes the barrier for future contributions. This is why Good First Issue exists.
## Adding a new project
You're welcome to add a new project in Good First Issue, and we encourage all projects — old and new, big and small.
Follow these simple steps:
- Our goal is to narrow down projects for new open-source contributors. To maintain the quality of projects in Good First Issue, please make sure your GitHub repository meets the following criteria:
- It has at least three issues with the `good first issue` label. This label is already present on all repositories by default. If not, you can follow the steps [here](https://help.github.com/en/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests).
- It has at least 10 contributors.
- It contains a README.md with detailed setup instructions for the project, and a CONTRIBUTING.md with guidelines for new contributors.
- It is actively maintained.
- Add your repository's path (in lexicographic order) in [data/repositories.toml](data/repositories.toml).
- Create a new pull-request. Please add the link to the issues page of the repository in the PR description. Once the pull request is merged, the changes will be live on [goodfirstissue.dev](https://goodfirstissue.dev/).
## Setting up the project locally
Good First Issue has two components — the front-end app built with Nuxt.js and a data population script written in Python.
To contribute new features and changes to the website, you would want to run the app locally. Please follow these steps:
1. Clone the project locally. Make sure you have Python 3 and a recent version of Node.js installed on your computer.
2. Make a copy of the sample data files for your local app to use and rename them to the filename that the app expects. **This step is important, as the front-end app won't work without these data files.**
```bash
$ cp data/generated.sample.json data/generated.json
$ cp data/tags.sample.json data/tags.json
```
3. Build the front-end app and start the development server.
```bash
$ bun install # install the dependencies
$ bun dev # start the development server
```
The app should open in your browser.