The CMS Repository Metrics Website shows an overview of software development activity across open source projects within a specified organization. This webpage is meant to be used by developers and program managers interested in repository health within CMS open source projects.
A metrics website that automatically pulls GitHub Repository data each week to produce numerical statistics and visualizations to aid developers and PMs in monitoring project health.
An up-to-date list of core team members can be found in MAINTAINERS.md.
- CONTRIBUTING.md
- MAINTAINERS.md
- CODEOWNERS.md
- COMMUNITY_GUIDELINES.md
- CODE_OF_CONDUCT.md
- SECURITY.md
- LICENSE
- Documentation
├── app
│ ├── dist
│ ├── node_modules
│ ├── site
│ └── src
├── scripts
│ ├── _metadata
│ ├── metricsLib
│ └── tests
└── templates
The following guide is for members of the project team who have access to the repository as well as code contributors. The main difference between internal and external contributions is that external contributors will need to fork the project and will not be able to merge their own pull requests. For more information on contribributing, see: CONTRIBUTING.md.
To collect metrics, first make sure you have set the following environment variables: - GITHUB_TOKEN - The github api key that you are using to collect data - AUGUR_HOST - The api domain corresponding to an instance of CHAOSS/Augur
Then, install the dependencies in requirements.txt.
Once the env is set up, either run the 'update data' GitHub Action in .github/workflows/update_data.yml or execute the update.sh shell script.
To run the server, make sure that your computer has npm installed.
Once npm is installed run npm install and npm start in the app/ directory.
-
Clone the repo
git clone https://github.com/DSACMS/metrics.git -
Install the required packages in requirements.txt (preferably in a virtual env)
pip3 install -r requirements.txt -
Install node dependencies
cd app && npm install && cd ..
This project adheres to PEP8 rules and guidelines whenever possible when accepting new contributions of Python code. Although, there are good reasons to ignore particular guidelines in particular situations. Further information on PEP8 can be found here.
This project utilizes pylint as the primary linter for backend code, while eslint and prettier handle code formatting and linting for the frontend. Checks are implemented upon new pull requests into protected branches to ensure code quality and consistency.
Python code quality checks are extremely useful for lowering the cost of maintenence of Python projects. Further information on Pylint can be found here.
We follow the GitHub Flow Workflow
- Fork the project
- Check out the
mainbranch - Create a feature branch
- Write code and tests for your change
- From your branch, make a pull request against
devif you have a feature change andmainif it is a hotfix - Work with repo maintainers to get your change reviewed and resolve git history if needed
- Wait for your change to be pulled into
devand later released intomain - Delete your feature branch
This project follows trunk-based development, which means:
- Make small changes in short-lived feature branches and merge to
devfrequently. - Be open to submitting multiple small pull requests for a single ticket (i.e. reference the same ticket across multiple pull requests).
- Treat each change you merge to
devandmainas immediately deployable to production. Do not merge changes that depend on subsequent changes you plan to make, even if you plan to make those changes shortly. - Ticket any unfinished or partially finished work.
- Tests should be written for changes introduced, and adhere to the text percentage threshold determined by the project.
This project uses continuous deployment using Github Actions which is configured in the ./github/worfklows directory.
Pull-requests are merged to main and the changes are immediately deployed to the development environment. Releases are created to push changes to production.
Thank you for considering contributing to an Open Source project of the US Government! For more information about our contribution guidelines, see CONTRIBUTING.md.
The contents of this repository are managed by the CMS Open Source Program Office. Those responsible for the code and documentation in this repository can be found in CODEOWNERS.md.
The CMS Repository Metrics Website team is taking a community-first and open source approach to the product development of this tool. We believe government software should be made in the open and be built and licensed such that anyone can download the code, run it themselves without paying money to third parties or using proprietary software, and use it as they will.
We know that we can learn from a wide variety of communities, including those who will use or will be impacted by the tool, who are experts in technology, or who have experience with similar technologies deployed in other spaces. We are dedicated to creating forums for continuous conversation and feedback to help shape the design and development of the tool.
We also recognize capacity building as a key part of involving a diverse open source community. We are doing our best to use accessible language, provide technical and process documents, and offer support to community members with a wide variety of backgrounds and skillsets.
Principles and guidelines for participating in our open source community are can be found in COMMUNITY_GUIDELINES.md. Please read them before joining or starting a conversation in this repo or one of the channels listed below. All community members and participants are expected to adhere to the community guidelines and code of conduct when participating in community spaces including: code repositories, communication channels and venues, and events.
If you have ideas for how we can improve or add to our capacity building efforts and methods for welcoming people into our community, please let us know at [email protected]. If you would like to comment on the tool itself, please let us know by filing an issue on our GitHub repository.
We adhere to the CMS Open Source Policy. If you have any questions, just shoot us an email.
Submit a vulnerability: Vulnerability reports can be submitted through Bugcrowd. Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see SECURITY.md.
A Software Bill of Materials (SBOM) is a formal record containing the details and supply chain relationships of various components used in building software.
In the spirit of Executive Order 14028 - Improving the Nation’s Cyber Security, a SBOM for this repository is provided here: https://github.com/DSACMS/metrics/network/dependencies.
For more information and resources about SBOMs, visit: https://www.cisa.gov/sbom.
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication as indicated in LICENSE.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request or issue, you are agreeing to comply with this waiver of copyright interest.