Skip to content

Commit

Permalink
Implement GitLab provider
Browse files Browse the repository at this point in the history
  • Loading branch information
zillemarco authored Oct 3, 2023
1 parent 6dfe2d5 commit c7bdd9a
Show file tree
Hide file tree
Showing 4 changed files with 1,565 additions and 1,342 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ Open-source maintainers are always looking to get more people involved, but it c

You're welcome to add a new project in First Issue, just follow these steps:

- To maintain the quality of projects in First Issue, please make sure the GitHub repository you want to add meets the following criteria:
- To maintain the quality of projects in First Issue, please make sure the repository you want to add meets the following criteria:

- It has at least three issues with the `good first issue` label or other labels defined in `config.json` (see `labels` and the end).
- For **GitHub** repositories: it has at least three issues with the `good first issue` label or other labels defined in [config.json](config.json) (see `labels` and the end of the `GitHub` provider).

- For **GitLab** repositories: it has at least three issues with the `quick win` label or other labels defined in [config.json](config.json) (see `labels` and the end of the `GitLab` provider).

- It has at least 10 contributors.

Expand All @@ -26,7 +28,9 @@ You're welcome to add a new project in First Issue, just follow these steps:

- It is actively maintained (last update less than 1 month ago).

- Add your repository's path (in the format `owner/name` and lexicographic order) to [config.json](config.json).
- For **GitHub** repositories: add your repository's path (in the format `owner/name` and lexicographic order) to [config.json](config.json) inside the `GitHub` provider.

- For **GitLab** repositories: add your repository's id (in the format `<project path>|<project id>`) to [config.json](config.json) inside the `GitLab` provider.

- 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 [firstissue.dev](https://firstissue.dev/).

Expand Down Expand Up @@ -57,6 +61,8 @@ $ npm run dev

Good to know when you commit: the project contains a `pre-commit` hook that runs linters automatically to ensure code quality!

**Note**: this project requires at least NodeJS 18.

## Credits

This project is based on [good-first-issue](https://github.com/deepsourcelabs/good-first-issue). The app and generation scripts have been rewritten using Next.js, React and Typescript, new features have been added and the UI is being updated too. The deployment process has been streamlined, complexity has been reduced and further improvements are planned.
Expand Down
Loading

0 comments on commit c7bdd9a

Please sign in to comment.