Skip to content

Commit

Permalink
Merge branch 'avelino:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
yuseferi authored Sep 18, 2024
2 parents 1bc6a5d + 15df93a commit 9874827
Show file tree
Hide file tree
Showing 11 changed files with 545 additions and 598 deletions.
46 changes: 30 additions & 16 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,40 @@
> Please check if what you want to add to `awesome-go` list meets [quality standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards) before sending pull request. Thanks!
## We want to ensure high quality of the packages. Make sure that you've checked the boxes below before sending a pull request.

**Please provide package links to:**
- [ ] I have read the [Contribution Guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines)
- [ ] I have read the [Maintainers Note](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#maintainers)
- [ ] I have read the [Quality Standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards)

- repo link (github.com, gitlab.com, etc):
- pkg.go.dev:
- goreportcard.com:
- coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), etc.):

**Note**: _that new categories can be added only when there are 3 packages or more._

**Make sure that you've checked the boxes below that apply before you submit PR.**
_Not every repository (project) will require every option, but most projects should. Check the Contribution Guidelines for details._

- [ ] The package has been added to the list in alphabetical order.
- [ ] The package has an appropriate description with correct grammar.
- [ ] As far as I know, the package has not been listed here before.
- [ ] The repo documentation has a pkg.go.dev link.
- [ ] The repo documentation has a coverage service link.
- [ ] The repo documentation has a goreportcard link.
- [ ] The repo has a version-numbered release and a go.mod file.
- [ ] I have read the [Contribution Guidelines](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#contribution-guidelines), [Maintainers Note](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#maintainers) and [Quality Standards](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards).
- [ ] The repo has a continuous integration process that automatically runs tests that must pass before new pull requests are merged.
- [ ] The authors of the project do not commit directly to the repo, but rather use pull requests that run the continuous-integration process.
- [ ] Continuous integration is used to attempt to catch issues prior to releasing this package to end-users.

## Please provide some links to your package to ease the review

- [ ] forge link (github.com, gitlab.com, etc):
- [ ] pkg.go.dev:
- [ ] goreportcard.com:
- [ ] coverage service link ([codecov](https://codecov.io/), [coveralls](https://coveralls.io/), etc.):

## Pull Request content

- [ ] The package has been added to the list in alphabetical order.
- [ ] The package has an appropriate description with correct grammar.
- [ ] As far as I know, the package has not been listed here before.

## Category quality

_Note that new categories can be added only when there are 3 packages or more._

Packages added a long time ago might not meet the current guidelines anymore. It would be very helpful if you could check 3-5 packages above and below your submission to ensure that they also still meet the Quality Standards.

Please delete one of the following lines:

- [ ] The packages around my addition still meet the Quality Standards.
- [ ] I removed the following packages around my addition: (please give a short reason for each removal)

Thanks for your PR, you're awesome! :+1:
Thanks for your PR, you're awesome! :sunglasses:
10 changes: 6 additions & 4 deletions .github/workflows/pull-request-first-comment.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
name: First comment in new pull request

on:
pull_request:
pull_request_target:
types: [opened]

jobs:
commentCreated:
runs-on: ubuntu-latest
permissions:
pull-requests: write
issues: write
environment: action
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand All @@ -19,11 +20,12 @@ jobs:
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.pull_request.number }}
body: |
Thank you for contributing with [awesome-go](https://awesome-go.com/), we will revise your contribution as soon as possible.
Thank you for contributing to [awesome-go](https://awesome-go.com/). We will review your contribution as soon as possible.
Make sure you add the links in the body of the pull request that are requested in the [contribution guide](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md):
- godoc.org or pkg.go.dev
- repo link
- pkg.go.dev
- goreportcard.com
- coverage
> your project is about to be approved, it's under revision, it may take a few days
> Your project is under review. It may take a few days to be approved.
4 changes: 2 additions & 2 deletions .github/workflows/run-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ jobs:
runs-on: ubuntu-latest
container: golang:latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Get dependencies
run: go get -v -t -d ./...
- name: run script
run: go test stale_repositories_test.go scripts.go
run: go test -v -run ^TestStaleRepository$
env:
OAUTH_TOKEN: ${{secrets.OAUTH_TOKEN}}
2 changes: 1 addition & 1 deletion .github/workflows/site-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
environment: netlify
container: golang:latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Get dependencies
run: go get -v -t -d ./...
- name: Make awesome-go.com
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
runs-on: ubuntu-latest
container: golang:latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Get dependencies
run: go get -v -t -d ./...
- name: Run tests
Expand Down
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
This resource was made by the Go community and wouldn't be possible without you!
We appreciate and recognize [all contributors](https://github.com/avelino/awesome-go/graphs/contributors).


# Contribution Guidelines

> Please be aware that we want to accept your contribution, but we have **some rules to keep the minimum quality** of the packages listed here. All reviews are **not personal feedback**, even if you are a _developer reviewing your contribution_. **Sorry, if we can't meet your expectations; we do our best**.
Expand All @@ -12,6 +13,9 @@ and other lists, awesome-go is a specially curated list of high-quality, activel

Please contribute links to packages/projects you have used or are familiar with. This will help ensure high-quality entries.

> the maintainers do not work full-time on the project, meaning that we do not have a set periodicity for reviewing contributions - rest assured that we will do our best to review and eventually accept contributions

## Quality standards

To be on the list, project repositories should adhere to the following quality standards.
Expand All @@ -30,6 +34,7 @@ To be on the list, project repositories should adhere to the following quality s

Categories must have at least 3 items.


## Preparing for review

Projects listed must have the following in their documentation. When submitting, you will be asked
Expand All @@ -44,6 +49,7 @@ One way to accomplish the above is to add badges to your project's README file.
- Go to https://goreportcard.com/ to generate a Go Report Card report, then click on the report badge in the upper-right corner to see details on how to add the badge to your README.
- Codecov, coveralls, and gocover all offer ways to create badges for code coverage reports. Another option is to generate a badge as part of a continuous integration process. See [Code Coverage](COVERAGE.md) for an example.


## How to add an item to the list

Open a pull request against the README.md document that adds the repository to the list.
Expand All @@ -70,6 +76,8 @@ You are an outstanding project now! Feel encouraged to tell others about it by a
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go)
```


## Maintenance expectations for projects listed here

To prevent removal from awesome-go, your project must maintain the following quality standards.
Expand All @@ -82,6 +90,7 @@ Highly recommended but not required:
- That the project uses a pull-request process, and the owners do not commit directly to the repository
- That the pull-request process requires the continuous-integration tests to pass before a pull request can be merged


## How to remove an item from the list

- Open a pull request that deletes the line of the project in question.
Expand All @@ -107,6 +116,7 @@ This project is scheduled to be removed within 2 weeks of this posting. To conti

Then, comment on your PR at awesome-go with a link to the removal issue at the project.


## Maintainers

To make sure every PR is checked, we have [team maintainers](MAINTAINERS). Every PR MUST be reviewed by at least one maintainer before it can get merged.
Expand All @@ -124,6 +134,35 @@ Removal changes will not be applied until they have been pending for a minimum o

Thanks, everyone!


## How decisions are made

The official group of maintainers has the final decision on what PRs are accepted. Discussions are made openly in issues. Decisions are made by consensus.


## How to become a contributor?

awesome-go is an open source project (created and maintained by the community), we are always open to new people to help us review the contributions (pull requests), **you don't need permission** or _name on the maintainers list_ to review a contribution and mark it as **LGTM**.

> Before you do anything, please read [this topic](https://github.com/avelino/awesome-go/blob/main/CONTRIBUTING.md#quality-standards) very carefully.
Now that you've read it, let's go!

Go into the pull requests (PR) and look at the following aspects:

* **shared links in the body of the PR:** they need to be valid and follow the quality specified above
* **check that the link added to `README.md`** is the same as the link to the repository mentioned in the body of the PR.
* **is it in the correct category?**

If everything is OK, mark the PR as approved, [read this documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request#starting-a-review) on how to do it.

**Welcome to awesome-go!**


## How to become an ~~"official maintainer"~~?

We don't give this name to people who are allowed to accept the PR.

If you are a person who is constantly active in reviewing PR and contributing to the project, you will be invited by a maintainer.

> **remember:** if you stop contributing with awesome-go for a long time, you will automatically be removed from the list of maintainers.
Loading

0 comments on commit 9874827

Please sign in to comment.