Skip to content

Commit 72186d0

Browse files
Merge pull request #17 from DSACMS/nat/docs
Docs: Updated all markdown files with project documentation
2 parents 9a295f8 + e701009 commit 72186d0

File tree

5 files changed

+219
-178
lines changed

5 files changed

+219
-178
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!--
2+
Thank you for sending the PR! We appreciate you spending the time to work on
3+
these changes.
4+
5+
Help us understand your motivation by explaining why you decided to make this change.
6+
7+
Happy contributing!
8+
9+
- Comments should be formatted to a width no greater than 80 columns.
10+
11+
- Files should be exempt of trailing spaces.
12+
13+
- We adhere to a specific format for commit messages. Please write your commit
14+
messages along these guidelines. Please keep the line width no greater than 80
15+
columns (You can use `fmt -n -p -w 80` to accomplish this).
16+
17+
18+
-->
19+
20+
## module-name: One line description of your change (less than 72 characters)
21+
22+
## Problem
23+
24+
Explain the context and why you're making that change. What is the problem
25+
you're trying to solve? In some cases there is not a problem and this can be
26+
thought of being the motivation for your change.
27+
28+
## Solution
29+
30+
Describe the modifications you've done.
31+
32+
## Result
33+
34+
What will change as a result of your pull request? Note that sometimes this
35+
section is unnecessary because it is self-explanatory based on the solution.
36+
37+
Some important notes regarding the summary line:
38+
39+
- Describe what was done; not the result
40+
- Use the active voice
41+
- Use the present tense
42+
- Capitalize properly
43+
- Do not end in a period — this is a title/subject
44+
- Prefix the subject with its scope
45+
46+
## Test Plan
47+
48+
(Write your test plan here. If you changed any code, please provide us with
49+
clear instructions on how you verified your changes work.)

CODEOWNERS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Code Owners
2-
<!-- TODO: Who are the points of contact in your project who are responsible/accountable for the project? This can often be an engineering or design manager or leader, who may or may not be the primary maintainers of the project. List them by GitHub Username-->
32

4-
- natalialuzuriaga
3+
<!-- TODO: Who are the points of contact in your project who are responsible/accountable for the project? This can often be an engineering or design manager or leader, who may or may not be the primary maintainers of the project. List them by GitHub Username-->
54

5+
- [@natalialuzuriaga](https://github.com/natalialuzuriaga)
66

77
## Repo Domains
88

@@ -28,5 +28,5 @@ To set up GitHub teams:
2828
2929
-->
3030

31-
/docs/ {Git usernames of documentation owners}
32-
/frontend/ {Git usernames of frontend owners}
31+
/css, /js [@natalialuzuriaga](https://github.com/natalialuzuriaga)
32+
/schemas [@natalialuzuriaga](https://github.com/natalialuzuriaga) [@decause-gov](https://github.com/decause-gov)

CONTRIBUTING.md

Lines changed: 29 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
<!--- # NOTE: Modify sections marked with `TODO` -->
2-
31
# How to Contribute
42

53
<!-- Basic instructions about where to send patches, check out source code, and get development support.-->
@@ -15,39 +13,47 @@ We encourage you to read this project's CONTRIBUTING policy (you are here), its
1513

1614
## Getting Started
1715

18-
<!--- TODO: If you have 'good-first-issue' or 'easy' labels for newcomers, mention them here.-->
16+
To run the project locally,
17+
18+
1. Start up a HTTP server using python: `python3 -m http.server 8000`
19+
2. Upon launch, here is the form! Right click to inspect to open developer tools for troubleshooting
20+
3. Fill out form
21+
4. Click submit, which triggers a local download of the completed code.json
1922

2023
### Team Specific Guidelines
2124

22-
<!-- 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.-->
25+
- Please try to keep pull requests to a reasonable size; try to split large contributions to multiple PRs
26+
- Please create pull requests into dev unless the contribution is some kind of bugfix or urgent hotfix
27+
- Document and explain the contribution clearly according to provided standards when possible
28+
- 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)
2329

2430
### Building dependencies
2531

26-
<!--- TODO: This step is often skipped, so don't forget to include the steps needed to install on your platform. If you project can be multi-platform, this is an excellent place for first time contributors to send patches!-->
32+
Python is required in order to run this project locally.
2733

2834
### Building the Project
2935

30-
<!--- TODO: Be sure to include build scripts and instructions, not just the source code itself! -->
36+
1. Start up a HTTP server using python: `python3 -m http.server 8000`
3137

3238
### Workflow and Branching
3339

34-
<!--- TODO: Workflow Example
3540
We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow/)
3641

3742
1. Fork the project
38-
2. Check out the `main` branch
43+
2. Check out the `dev` branch
3944
3. Create a feature branch
4045
4. Write code and tests for your change
41-
5. From your branch, make a pull request against `DSACMS/codejson-generator/main`
46+
5. From your branch, make a pull request against `DSACMS/codejson-generator/dev`
4247
6. Work with repo maintainers to get your change reviewed
4348
7. Wait for your change to be pulled into `DSACMS/codejson-generator/main`
4449
8. Delete your feature branch
45-
-->
4650

4751
### Testing Conventions
4852

4953
<!--- TODO: Discuss where tests can be found, how they are run, and what kind of tests/coverage strategy and goals the project has. -->
5054

55+
We are working on tests at the moment. Stay tuned.
56+
5157
### Coding Style and Linters
5258

5359
<!--- TODO: HIGHLY ENCOURAGED. Specific tools will vary between different languages/frameworks (e.g. Black for python, eslint for JavaScript, etc...)
@@ -59,9 +65,9 @@ We follow the [GitHub Flow Workflow](https://guides.github.com/introduction/flow
5965
6066
-->
6167

62-
### Writing Issues
68+
Prettier is used for HTML/CSS and Javascript formatting. Stay tuned for the prettier config file.
6369

64-
<!--- TODO: Example Issue Guides
70+
### Writing Issues
6571

6672
When creating an issue please try to adhere to the following format:
6773

@@ -80,12 +86,9 @@ When creating an issue please try to adhere to the following format:
8086
List all relevant steps to reproduce the observed behavior.
8187

8288
see our .github/ISSUE_TEMPLATE.md for more examples.
83-
-->
8489

8590
### Writing Pull Requests
8691

87-
<!-- TODO: Make a brief statement about where to file pull/merge requests, and conventions for doing so. Link to PULL_REQUEST_TEMPLATE.md file.
88-
8992
Comments should be formatted to a width no greater than 80 columns.
9093

9194
Files should be exempt of trailing spaces.
@@ -113,56 +116,32 @@ columns (You can use `fmt -n -p -w 80` to accomplish this).
113116

114117
Some important notes regarding the summary line:
115118

116-
* Describe what was done; not the result
117-
* Use the active voice
118-
* Use the present tense
119-
* Capitalize properly
120-
* Do not end in a period — this is a title/subject
121-
* Prefix the subject with its scope
119+
- Describe what was done; not the result
120+
- Use the active voice
121+
- Use the present tense
122+
- Capitalize properly
123+
- Do not end in a period — this is a title/subject
124+
- Prefix the subject with its scope
122125

123-
see our .github/PULL_REQUEST_TEMPLATE.md for more examples.
124-
-->
126+
see our .github/PULL_REQUEST_TEMPLATE.md for more examples.
125127

126128
## Reviewing Pull Requests
127129

128-
<!--- TODO: Make a brief statement about how pull-requests are reviewed, and who is doing the reviewing. Linking to MAINTAINERS.md can help.
129-
130-
Code Review Example
131-
132-
The repository on GitHub is kept in sync with an internal repository at
133-
github.cms.gov. For the most part this process should be transparent to the
134-
project users, but it does have some implications for how pull requests are
135-
merged into the codebase.
136-
137130
When you submit a pull request on GitHub, it will be reviewed by the project
138-
community (both inside and outside of github.cms.gov), and once the changes are
139-
approved, your commits will be brought into github.cms.gov's internal system for
140-
additional testing. Once the changes are merged internally, they will be pushed
141-
back to GitHub with the next sync.
142-
143-
This process means that the pull request will not be merged in the usual way.
144-
Instead a member of the project team will post a message in the pull request
145-
thread when your changes have made their way back to GitHub, and the pull
146-
request will be closed.
147-
148-
The changes in the pull request will be collapsed into a single commit, but the
149-
authorship metadata will be preserved.
150-
151-
-->
131+
community, and once the changes are approved, your commits will be brought into the main branch that deploys the production website.
152132

153133
<!--
154134
## Shipping Releases
155135
156-
<!-- TODO: What cadence does your project ship new releases? (e.g. one-time, ad-hoc, periodically, upon merge of new patches) Who does so?
136+
<!-- TODO: What cadence does your project ship new releases? (e.g. one-time, ad-hoc, periodically, upon merge of new patches) Who does so?
157137
-->
158138

159139
## Documentation
160140

161-
<!-- TODO: Documentation Example
141+
At the moment, we are working on documentation for the CMS code.json schema. Stay tuned.
162142

163143
We also welcome improvements to the project documentation or to the existing
164144
docs. Please file an [issue](https://github.com/DSACMS/codejson-generator/issues).
165-
-->
166145

167146
## Policies
168147

@@ -174,7 +153,7 @@ questions, just [shoot us an email](mailto:[email protected]).
174153

175154
### Security and Responsible Disclosure Policy
176155

177-
*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.
156+
_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.
178157

179158
For more information about our Security, Vulnerability, and Responsible Disclosure Policies, see [SECURITY.md](SECURITY.md).
180159

0 commit comments

Comments
 (0)