Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.92 KB
Raw

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.

  • To add, remove, or change things on the list: Submit a pull request

  • List items should be sorted alphabetically;

  • Each item should be limited to one link;

  • The link should be the name of the package or project;

  • Descriptions should be clear, concise, and non-promotional;

  • Descriptions should follow the link, on the same line and end with a punctuation mark;

  • At least 3 items are needed to create a new category;

  • The package or project had to be maintained under open source license ( we make a brief review of the code before the link enters the list ), see list of allowed licenses;

  • Remember to put a period . at end of the project description.

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

Quality standards

To be on the list, project repositories should adhere to these quality standards (https://goreportcard.com/report/github.com/ github_user / github_repo):

  • Code functions as documented and expected
  • Generally useful to the wider community of Go programmers
  • Actively maintained
    • Regular, recent commits
    • Or, for finished projects, issues and pull requests are responded to
  • Stable or progressing toward stable
  • Thoroughly documented (README, pkg.go.dev doc comments, etc.) in english language, so everyone is able to understand the project's intention and how it works

Congrats, your project got accepted - what now?

You are an awesome project now! Feel encouraged to tell others about it by adding one of these badges:
Mentioned in Awesome Fiber
Mentioned in Awesome Fiber

[![Mentioned in Awesome Fiber](https://awesome.re/mentioned-badge.svg)](https://github.com/gofiber/awesome-fiber)  
[![Mentioned in Awesome Fiber](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/gofiber/awesome-fiber)

Reporting issues

Please open an issue if you would like to discuss anything that could be improved or have suggestions for making the list a more valuable resource. We realize sometimes packages fall into abandonment or have breaking builds for extended periods of time, so if you see that, feel free to change its listing or let us know. We also realize that sometimes projects are just going through transitions or are more experimental in nature. These can still be cool, but we can indicate them as transitory or experimental.

Thanks everyone!