Skip to content

Commit

Permalink
docs: start conversation on contribution standards (#508)
Browse files Browse the repository at this point in the history
Co-authored-by: Phil Sturgeon <67381+philsturgeon@users.noreply.github.com>
  • Loading branch information
AndrewWalsh and philsturgeon authored May 27, 2024
1 parent f8827fc commit 1b1e6e6
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Contributing

We encourage all efforts in the OpenAPI ecosystem, and none of these tools are easy to create and maintain. That said, we don't want to be an exhaustive list of every single tool out there. OpenAPI.Tools is a curated list, which aims to help people find modern, reliable tooling, that's of as high quality as we can reasonably hope for.

Our focus on high-quality tooling means we cannot accept every tool that would like to be listed here, at least not right away. Submissions must align with the following guidelines:
- **Real-world use**: there should be evidence that people are using it, perhaps through package downloads, GitHub stars, or other means
- **Testable**: submissions should be released, and there should be a way of testing it so we can validate it works
- **Relevant**: all submissions must relate to the OpenAPI ecosystem and abide by its [Code of Conduct](https://github.com/OAI/OpenAPI-Specification/blob/main/CODE_OF_CONDUCT.md)
- **Terminology**: descriptions and language should follow the [OpenAPI Glossary](https://github.com/openapi-contrib/glossary?tab=readme-ov-file#api-description)

## How to Run the Site Locally

We use [jekyll](https://jekyllrb.com/) so you should use ruby and install it using bundler.

```
Expand Down

0 comments on commit 1b1e6e6

Please sign in to comment.