We need to create a 3-minute advertisement for our project.

Our project thankfully doesn't need to be done to create the video. Instead, we can focus on the "how, what, why and why not" per the documentation.

One approach might be something like:

Contributing to open-source is difficult. There are 100's to choose from, but how do you know the project you are choosing to contribute to has made it easy to do so?
Maintaining an open-source project is just as difficult. How to help prospective developers know your project is not just worth contributing to, but also easy?
Constable aims to fix this problem. The goal of constable is to provide a simple letter grade score for a repository to let developers know how "contributable" the project is.
Initially being developed as a GitHub action - making it super simple to add to your project! - the goal is to make it easy for project maintainers to see the score for their project, check it with every change, and even create a badge to show off on their README.md
If you care about helping the open-source community continue to make it easier for everyone to contribute to projects, consider using (and contributing to) Constable!

Based on the reports for the README and other checks, create a simple report that can be output from the action and used in other actions.

The action.yml file will need to be updated with the output param as well.

Add a script with badge that will dynamically generate a webpage(redirected in a new tab). This data will come from firebase database in real time.

Update our action to perform a simple binary check for the presence of a README.md file in a repository using the action.

Likely a new project, but we eventually want any repository owner to check if a project is contributable by simply providing a public git URL.

• a simple UI that accepts a git URL
• a REST API that allows for checking a downloaded repo
• API reports the same outputs of the action as a JSON body

• the what
• the how
• the why
• the why not something else

Include badges for

• eslint?
• semver?
• GitHub Actions for automated tests status?

Add a binary check for the CODE_OF_CONDUCT.md file in the repository using the action.

Use GitHub actions to keep a changelog up-to-date and to generate releases notes on merges to master.

Write a CODE_OF_CONDUCT.md for our repo

Write up the initial CONTRIBUTING.md document for our repository.

Should mention the Kanban board, status checks, etc.

Simple binary check for a CONTRIBUTING.md file in the repository using the GitHub action

Use the --coverage option in jest to collect and report code coverage

Consider adding a badge to our README

Document the action expected inputs and ouputs to run. Should also discuss the need for the GitHub Token as an env variable.

There are a few ways to do this:

• 1. Would be update the README.md file and updating the badge with a static badge via Shields.io
• 2. Send data to a REST API to generate a dynamic Shields.io
• 3. Send data and create a badge image via a REST API

See https://editorconfig.org/

We should add the config for JS and YAML to make sure we don't get errors in our yaml file

Allow a user to specify custom weights for various checks/files