Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

74 lines (55 loc) · 1.92 KB
Raw

How to Add a CMS to Awesome CMS

Awesome CMS currently accepts open-source CMSes with over 50 stars on GitHub and a commit within the last year. Closed-source CMSes will be judged on a case-by-case basis.

Note: Do not generate README.md. That will happen after your pull request is accepted.

On GitHub

1. Create a new file in the data folder named as follows:

  • Open source? Use the lowercase filename org#repo.toml.
  • Closed source? Use the lowercase product name, with dashes substituted for spaces product-name.toml.

2. Fill out this template

name = ""
description = ""
# A URL other than the GitHub URL
url = ""
# If there's an awesome list for this CMS.
awesome_repo = "org/repo"
# Only if it's open source
github_repo = "org/repo"
# Lower case, e.g. javascript, php, c#.
language = ""

Example

name = "WordPress"
description = "WordPress is a free and open-source content management system (CMS) based on PHP and MySQL."
url = "https://wordpress.org"
github_repo = "WordPress/WordPress"
awesome_repo = "miziomon/awesome-wordpress"
language = "php"

3. Submit a pull request.

Be sure to check the boxes in the pull request template.

On Your Computer

  1. Fork the repo on GitHub.
  2. Clone the project.
  3. Follow the steps above.
  4. Push your work back up to your fork.
  5. Submit a pull request.

How README.md is Generated

All scripts require Node 6 or greater. Use NVM to easily install it.

The Data Folder

The files in the /data folder and meta.toml use the human-friendly TOML markup language. Together, they are used to generate the README.

# Edit something in /data
npm install
npm run generateReadme