Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

52 lines (36 loc) · 2.92 KB
Raw

Contribution Guidelines

We would like to accept contributions of projects that meet these minimum quality guidelines.

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
  • At least 3 items are needed to create a new category;
  • The package or project must be maintained under open source license, see list of allowed licenses.

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

  • 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, docs.rs (rust), pkg.go.dev (go), doc comments, etc.) in english language, so everyone is able to understand the project's intention and how it works
  • Tests, where practical.

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 wasmcloud
Mentioned in Awesome wasmcloud

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

Maintainers

We will review your PR and notify you and tag it in case any information is still missing. Please give us a few days to respond to PRs.

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 projects 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.

Removal changes will not be applied until they have been pending for a minimum of 1 week (7 days). This grace window benefits projects that may be going through a temporary transition but are otherwise worthy of being on the list.

Thanks everyone!