From fc676ff7cf36d92169661f746d19432610dae64b Mon Sep 17 00:00:00 2001 From: gomzyakov Date: Sat, 21 Oct 2023 22:43:41 +0500 Subject: [PATCH 1/4] Draft of text --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f317eae..f16b440 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# good first issue +# Good First Issue Make your first open-source contribution. -https://gomzyakov.github.io/good-first-issue/ +A website that targets developers who want to contribute to open source software but do not know where or how to start. +Good First Issues empowers first-time contributors of open-source software. This website is primarily targeted at developers who want to contribute to open source software but do not know where or how to start. By providing developers with filters, the website empowers them to browse and select issues/repositories based on programming languages that they are comfortable with. In addition, they can select the type of issues they want to work on. + +Website: + # Как добавить свой репозиторий? todo [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json) @@ -14,6 +18,10 @@ todo [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main # Как это работает? -https://api.github.com/repos/gomzyakov/good-first-issue/issues?state=open&sort=updated&labels=good%20first%20issue -Ежедневно запускается [cron.yml](#TODO) который _TODO_ +## Dependencies + +- [Bootstrap](https://getbootstrap.com) for theme and frontend components +- [PHP](https://www.php.net) and [GitHub Workflow](https://docs.github.com/en/actions/using-workflows) for periodically calling [GitHub REST API](https://docs.github.com/en/rest) + + From 8f9ce431a4ace23657bfd805e90e5da739b7e7ae Mon Sep 17 00:00:00 2001 From: gomzyakov Date: Sun, 22 Oct 2023 20:04:05 +0500 Subject: [PATCH 2/4] Update README.md --- README.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f16b440..233f4a7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,40 @@ -# Good First Issue +# Good First Issues -Make your first open-source contribution. +**Good First Issues** is an initiative to curate easy pickings from popular projects, so developers who've never contributed to open-source can get started quickly. +Website: [good-first-issues.github.io](https://good-first-issues.github.io) -A website that targets developers who want to contribute to open source software but do not know where or how to start. +This website is primarily targeted at developers who want to contribute to open source software but do not know where or how to start. +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 Issues* exists. -Good First Issues empowers first-time contributors of open-source software. This website is primarily targeted at developers who want to contribute to open source software but do not know where or how to start. By providing developers with filters, the website empowers them to browse and select issues/repositories based on programming languages that they are comfortable with. In addition, they can select the type of issues they want to work on. +## Adding a new project -Website: +You're welcome to add a new project in *Good First Issues*, 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 Issues*, 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 contains a `README.md` with detailed setup instructions for the project + + - It is actively maintained + +- Add your repository's path (in lexicographic order) in [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json). + +- 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 [good-first-issues.github.io](https://good-first-issues.github.io). + +## Suggestions and wishes + +If you have questions or suggestions (or found a bug), you can always write to [issues](https://github.com/good-first-issues/good-first-issues.github.io/issues). + +## License + +This is open-sourced software licensed under the [MIT License](https://github.com/good-first-issues/good-first-issues.github.io/blob/main/LICENSE). -# Как добавить свой репозиторий? -todo [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json) # Как это работает? From f9d147a5b993d5152c53a6a7888b23ea37bcfd05 Mon Sep 17 00:00:00 2001 From: gomzyakov Date: Sun, 22 Oct 2023 20:40:48 +0500 Subject: [PATCH 3/4] Update README.md --- .github/workflows/phpunit.yml | 2 +- README.md | 34 +++++++++++++++------------------- src/Generator.php | 1 + 3 files changed, 17 insertions(+), 20 deletions(-) diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml index 4b9b146..d2d287c 100644 --- a/.github/workflows/phpunit.yml +++ b/.github/workflows/phpunit.yml @@ -41,7 +41,7 @@ jobs: with: token: ${{ secrets.CODECOV_TOKEN }} files: ./coverage.xml - fail_ci_if_error: true + fail_ci_if_error: false flags: unittests name: codecov-umbrella verbose: true diff --git a/README.md b/README.md index 233f4a7..d8e8f70 100644 --- a/README.md +++ b/README.md @@ -10,40 +10,36 @@ Open-source maintainers are always looking to get more people involved, but new ## Adding a new project -You're welcome to add a new project in *Good First Issues*, and we encourage all projects — old and new, big and small. +You're welcome to add a new project in *Good First Issues*, just follow these steps: -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 Issues*, please make sure your GitHub repository meets the following criteria: +- To maintain the quality of projects in *Good First Issues*, 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 contains a `README.md` with detailed setup instructions for the project - - It is actively maintained + - It is actively maintained (last update less than 1 month ago) -- Add your repository's path (in lexicographic order) in [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json). +- Add your repository's path (in the format `owner/name` and lexicographic order) in [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json). - 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 [good-first-issues.github.io](https://good-first-issues.github.io). -## Suggestions and wishes - -If you have questions or suggestions (or found a bug), you can always write to [issues](https://github.com/good-first-issues/good-first-issues.github.io/issues). - -## License - -This is open-sourced software licensed under the [MIT License](https://github.com/good-first-issues/good-first-issues.github.io/blob/main/LICENSE). - +## How does it work? +- First *Good First Issues* is a static website that uses [PHP](https://www.php.net)` to generate HTML files. +- We use [GitHub REST API](https://docs.github.com/en/rest) to fetch issues from the repositories listed in [repositories.json](https://github.com/gomzyakov/good-first-issue/blob/main/repositories.json). +- To periodically cycle through issues (twice a day), we use [GitHub Workflow](https://docs.github.com/en/actions/using-workflows). +## Help us grow -# Как это работает? +Navigating open-source projects can be quite overwhelming for beginners and experienced contributors alike. *Good First Issues* looks to solve this problem by providing a platform that serves as a starting point for those looking to get started with open-source or those who are looking to get into a new project. +The more people who know about [good-first-issues.github.io](https://good-first-issues.github.io), the better. There are various ways you can help us grow: you could contribute to `awesome` lists, blog about us, reach out to bloggers, tech influences, developer and open-source on Twitter and YouTube, for example. Try and get [good-first-issues.github.io](https://good-first-issues.github.io) mentioned in a video or tweet! +## Suggestions and wishes -## Dependencies - -- [Bootstrap](https://getbootstrap.com) for theme and frontend components -- [PHP](https://www.php.net) and [GitHub Workflow](https://docs.github.com/en/actions/using-workflows) for periodically calling [GitHub REST API](https://docs.github.com/en/rest) +If you have questions or suggestions (or found a bug), you can always write to [issues](https://github.com/good-first-issues/good-first-issues.github.io/issues). +## License +This is open-sourced software licensed under the [MIT License](https://github.com/good-first-issues/good-first-issues.github.io/blob/main/LICENSE). diff --git a/src/Generator.php b/src/Generator.php index c3e62ca..68c60c5 100644 --- a/src/Generator.php +++ b/src/Generator.php @@ -37,6 +37,7 @@ public function run(): void $repositories = $this->github_api_client->requestRepositoriesData($repository_names); // TODO сортируем репозитории по updated at + // TODO удаляем неактивные репозитории foreach ($repositories as $repository) { print_r('Get issues for repository: ' . $repository->full_name . "\n"); From 3cbec6df3bf694d1d864495643d0b586ab7e9f81 Mon Sep 17 00:00:00 2001 From: gomzyakov Date: Sun, 22 Oct 2023 20:46:46 +0500 Subject: [PATCH 4/4] Add RendererTest.php --- tests/RendererTest.php | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 tests/RendererTest.php diff --git a/tests/RendererTest.php b/tests/RendererTest.php new file mode 100644 index 0000000..9342ba2 --- /dev/null +++ b/tests/RendererTest.php @@ -0,0 +1,21 @@ +assertInstanceOf(Renderer::class, $generator); + } +}