Skip to content

Latest commit

 

History

History
78 lines (45 loc) · 3.13 KB

README.md

File metadata and controls

78 lines (45 loc) · 3.13 KB
Collective Funds

Open source projects collects funds – but how do they spend them?

The Collective Funds Guidelines provides a framework for the use of funds.

Status

An early v0.1 draft of the guidelines are available for early adoptors while we gather feedback.

Guidelines are not recommended for wider adoption until it reaches a stable v1.0.0 (staying in line with Semantic Versioning).

Where

The current version of the guidelines are found in GUIDELINES.md.

Historic versions are tagged in git and can be found in releases on GitHub.

Used by

Current users

  • Mocha, see FUNDING.md
  • (Your project? Open a PR!)

In discussion

  • Neostandard
  • (Your project? Open a PR!)

How to Adopt

You adopt the guidelines by noting the use in your FUNDING.md file or README.md.

See details in the How to Adopt Guidelines section of the guidelines.

Badges

If you use the Collective Funds Guidelines for your project, you can improve discoverability of it by using one of these badges in your README.md:

Collective Funds Guidelines v0.1

[![Collective Funds Guidelines v0.1](https://img.shields.io/badge/collective_funds_guidelines-v0.1-D8E8D4?style=flat&labelColor=3A6457)](https://github.com/collective-funds/guidelines)

Collective Funds Guidelines v0.1

[![Collective Funds Guidelines v0.1](https://img.shields.io/badge/collective_funds_guidelines-v0.1-brightgreen?style=flat)](https://github.com/collective-funds/guidelines)

History

These guidelines are strongly inspired by the excellent prior art of ESLint and WebdriverIO.

They were initally drafted for the mocha and neostandard projects, aiming to provide them and other projects a common baseline that's easy to adopt and provides clarity on usage of funds – for maintainers as well as community.

First draft was written by @voxpelli with review and feedback from fellow co-maintainers and community.

To fascilitate feedback the Collective Funds group was set up, to help the community evolve the guidelines further.

License

The content of this repository (apart from names and logos) is licensed under the Creative Commons Attribution 4.0 International Public License.