Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.63 KB

Contribution Guidelines

All contributions to this list are welcome!

Adding a project

Important notes:

  • In order to avoid duplicates, please search existing pull requests before submitting a new one.
  • Make sure the project you'd like to add is clearly related to ASGI. General-purpose async projects can be submitted to awesome-asyncio instead. Likewise, in general framework-specific projects should be submitted to the corresponding lists, such as awesome-fastapi.

Edit README.md:

  • Choose one of the sections available. If no section fits the project, feel free to add a section.
  • Add the project to the section (keep alphabetical order):
    - [Project name](https://example.com) - A short description which ends with a period.
  • Check spelling and grammar.
  • Remove any trailing white space, and separate all headers, paragraphs, lists and code snippets with an empty line.

Once that's done, you can submit a PR. :-)

Adding a section

  • Add the section to the table of contents (keep alphabetical order):
## Contents

- ...
- [My Section Header](#my-section-header)
  • Add the section header and description in the README (keep alphabetical order);
## My section header

_My section description._

CI

A CI job checks for the order of entries.

To ensure entries are properly sorted locally before pushing a PR, use:

make format