https://github.com/cqfn/manifest
Quality Manifest for All Repositories
https://github.com/cqfn/manifest
manifest opensource
Last synced: 6 months ago
JSON representation
Quality Manifest for All Repositories
- Host: GitHub
- URL: https://github.com/cqfn/manifest
- Owner: cqfn
- Created: 2020-06-22T14:11:09.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-15T08:53:16.000Z (almost 5 years ago)
- Last Synced: 2024-04-14T22:50:52.601Z (over 1 year ago)
- Topics: manifest, opensource
- Homepage: https://www.cqfn.org
- Size: 8.79 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[CQFN](https://github.com/cqfn)
is the place where we keep experimental
and not-yet-ready-for-production open source products.
Even though our projects are experimental we expect their
authors to maintain them with the highest quality, according
to the best practices of open source community, including:
* Your product must be _somehow_ better than others on the market
* Your `README` must list all known competitors and explain why they are worse
* Actual version of repository is merged to primary branch (`master` or `main`)
* Branch names are informative, it is either linked to a ticket or describes feature verbosely
* Continuous integration is a must (use [Travis](https://travis-ci.org/) or [GitHub Actions](https://github.com/features/actions))
* Build automation and package management is a must
* At least all public entry points are documented using proper documentation tools (javadoc, etc)
* Static analysis is a must
* Your release procedure must be automated either via [@rultor](https://www.rultor.com) or [GitHub Actions](https://github.com/features/actions)
* [`CONTRIBUTING.md`](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors) must exist
* Your `README` must [look nice](https://www.yegor256.com/2019/04/23/elegant-readme.html)
* Your membership in [@cqfn](https://github.com/cqfn) must be "public" ([edit here](https://github.com/orgs/cqfn/people))
* Your contribution discipline is [exceptional](https://www.yegor256.com/2015/06/08/deadly-sins-software-project.html)
* Your license must be [MIT](https://opensource.org/licenses/MIT)
Use one of our existing projects as an example.
When you are ready to add your project here, just
[email us](mailto:team@cqfn.org).