Rapid

The tools you need to get your code from idea to production

What is rapid?

Rapid, quite simply, is a collection of style guides, tools, recommendations, and standards for Open Source Software (OSS). Rapid is designed to make contributing to open source as easy as possible by creating easily adoptable standards that make sense.

What does rapid support now?

Rapid is currently a work-in-progress and contributions are always welcome as we continue to grow our standards database to more programming languages and disciplines. Currently, rapid contains:

Name	Purpose	Prefix
Rapid Versioning System	The sane alternative to semantic versioning	v

How will rapid grow?

Rapid is dependent on contributors to continually increase the number of guides and standards we have for open source. If you have an idea, submit a PR to have it merged and incorporated in the next release of rapid.

How can I show that my project follows rapid guidelines?

If you use all of rapid's guidelines you can add this universal badge to your project's README with:

[![code standard: rapid](https://shields.mitmproxy.org/badge/code%20standard-rapid-blue)]
(https://github.com/quantum9innovation/rapid)

If instead your project only follows a certain rapid guideline (like uses Rapid versioning), or you want to explicitly list all rapid guidelines that your project follows, use the following badges:

Rapid Versioning System

[![versioning: rapid](https://shields.mitmproxy.org/badge/versioning-rapid-blue)]
(https://quantum9innovation.github.io/rapid/versioning/definition)

Directive Compliance

Alternatively, if you only follow a certain Rapid directive, you can use the directive: compliant badge format below*. If you follow all directives in a Rapid guideline except one or more directives, list them with the directive: non-compliant badges. You can also submit a PR explaining why our directive doesn't work for your project so we can add it to our ongoing collection of open source best practices.

*Please first see the directive prefixes in the table above

Badge Format for Compliance

[![prefix-directive](https://shields.mitmproxy.org/badge/prefix--directive-compliant-brightgreen)]
(https://github.com/quantum9Innovation/rapid)

Be sure to prelace prefix with the directive prefix and directive with the directive number (e.g. 2.3) in both the badge and URLs.

Badge Format for Non-Compliance

[![prefix-directive](https://shields.mitmproxy.org/badge/prefix--directive-non--compliant-red)]
(https://github.com/quantum9Innovation/rapid)

Be sure to prelace prefix with the directive prefix and directive with the directive number (e.g. 2.3) in both the badge and URLs.

That's it!

Thank you to all contributors that helped create rapid and continue to make it easier for people to contribute to OSS:

Made with contributors-img.