Updated CONTRIBUTING.md with up-to-date information:

Signed-off-by: Natalia Luzuriaga <[email protected]>

CONTRIBUTING.md

@@ -1,5 +1,3 @@
-<!--- # NOTE: Modify sections marked with `TODO` and then rename the file.-->
-
 # How to Contribute
 
 We're so thankful you're considering contributing to an [open source project of
@@ -13,16 +11,36 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its
 
 ## Getting Started
 
-<!--- ### TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here.-->
+First, install the required dependencies.
+
+To create a new repository using repo-scaffolder, run the production version of repo-scaffolder. Subsitute `X` with the tier number you'd like to create in the directory flag.
+
+```
+cookiecutter https://github.com/DSACMS/repo-scaffolder --directory=tierX
+```
+
+More commands on using repo-scaffolder for repository creation and maintenance can be found here: https://github.com/DSACMS/repo-scaffolder/blob/main/README.md#Using-repo-scaffolder
+
+### Team Specific Guidelines
+
+- Please try to keep pull requests to a reasonable size; try to split large contributions to multiple PRs
+- Please create pull requests into dev unless the contribution is some kind of bugfix or urgent hotfix.
+- Document and explain the contribution clearly according to provided standards when possible.
+- Feel free to reach out to us if there is any confusion. A list of the project maintainers is found here: [MAINTAINERS.md](./MAINTAINERS.md)
 
 ### Building dependencies
 
-In the root directory of the project,
-`pip install -r requirements.txt`
+1. Clone the repo
+
+   `git clone https://github.com/DSACMS/metrics.git`
+
+2. Install the required packages in requirements.txt
+
+   `pip install -r requirements.txt`
 
 ### Building the Project
 
-<!--- ### TODO -->
+N/A
 
 ### Workflow and Branching
 
@@ -37,13 +55,15 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
 7.  Wait for your change to be pulled into `cmsgov/cmsgov-example-repo/main`
 8.  Delete your feature branch
 
+### Testing Conventions
+
+<!--- TODO: Currently, does not have tests. Write tests then discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has. -->
+
 ### Coding Style and Linters
 
 This project strives to adhere to the Python Style Guide (http://peps.python.org/pep-0008/). We would recommend using a linter such as pyflakes, flake8, black, or other plugin for your editor or IDE of choice.
 
--->
-
-### Issues
+### Writing Issues
 
 When creating an issue please try to adhere to the following format:
 
@@ -63,7 +83,7 @@ When creating an issue please try to adhere to the following format:
 
     see our .github/ISSUE_TEMPLATE.md for more examples.
 
-### Pull Requests
+### Writing Pull Requests
 
 Comments should be formatted to a width no greater than 80 columns.
 
@@ -107,7 +127,7 @@ a development branch for additional testing. Once the changes are merged, they w
 be pushed back to the main branch.
 
 If the issue the pull request is addressing is particularly urgent, the pull request
-will be merged directly into the main branch. 
+will be merged directly into the main branch.
 
 ## Documentation
 
@@ -124,7 +144,7 @@ questions, just [shoot us an email](mailto:[email protected]).
 
 ### Security and Responsible Disclosure Policy
 
-*Submit a vulnerability:* Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). Reports may be submitted anonymously. If you share contact information, we will acknowledge receipt of your report within 3 business days.
+_Submit a vulnerability:_ Vulnerability reports can be submitted through [Bugcrowd](https://bugcrowd.com/cms-vdp). 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](SECURITY.md).
 
@@ -133,31 +153,3 @@ For more information about our Security, Vulnerability, and Responsible Disclosu
 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](https://creativecommons.org/publicdomain/zero/1.0/).
 
 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.
-
- ### Team Specific Guidelines 
-<!-- TODO: This section helps contributors understand any team structure in the project (formal or informal.) Encouraged to point towards the MAINTAINERS.md file for further details.--> 
-
- ### Testing Conventions 
-<!--- TODO: Discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has. --> 
-
- ### Writing Pull Requests 
-<!-- TODO: Make a brief statement about where to file pull/merge requests, and conventions for doing so. Link to PULL_REQUEST_TEMPLATE.md file.
- Comments should be formatted to a width no greater than 80 columns.
- Files should be exempt of trailing spaces.
- We adhere to a specific format for commit messages. Please write your commit messages along these guidelines. Please keep the line width no greater than 80 columns (You can use `fmt -n -p -w 80` to accomplish this).
- module-name: One line description of your change (less than 72 characters)
- Problem
- Explain the context and why you're making that change. What is the problem you're trying to solve? In some cases there is not a problem and this can be thought of being the motivation for your change.
- Solution
- Describe the modifications you've done.
- Result
- What will change as a result of your pull request? Note that sometimes this section is unnecessary because it is self-explanatory based on the solution.
- Some important notes regarding the summary line:
- workflows Describe what was done; not the result
- workflows Use the active voice
- workflows Use the present tense
- workflows Capitalize properly
- workflows Do not end in a period — this is a title/subject
- workflows Prefix the subject with its scope
- see our .github/PULL_REQUEST_TEMPLATE.md for more examples.
- -->