Skip to content

Commit 62a5dfb

Browse files
committed
adding contributing.md and iterating on readme.md
1 parent 6f681ba commit 62a5dfb

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

CONTRIBUTING.MD

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing to Nava Strata
2+
3+
Thank you for your interest in contributing to Nava Strata! Strata is a gold-standard target architecture and suite of open source tools that gives government agencies everything they need to run a modern service. We welcome contributions from developers, designers, policy experts, and community members. This document outlines how members of the community should approach the contribution process.
4+
5+
## Community
6+
7+
We are committed to providing a welcoming environment for all contributors. All contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## Bugs and issues
10+
11+
Bug reports are welcome, as they make Strata better for everyone who uses it. Create a GitHub issue using the bug template to make sure it contains the neccessary information for us to triage the issue. Prior to filing an issue, please search the existing issues to make sure it is not a duplicate.
12+
13+
If the issue is related to security, please email us directly at [email protected]
14+
15+
## Getting Started
16+
17+
To contribute, create a pull request on GitHub with:
18+
19+
- Clear title and description
20+
- Reference to related issues
21+
- Screenshots for UI changes
22+
- Test results and coverage
23+
24+
## Code Review Process
25+
26+
### Submitting for Review
27+
28+
- Ensure all tests pass
29+
- Update documentation
30+
- Self-review your changes
31+
- Request review from appropriate team members
32+
33+
### Review Criteria
34+
35+
Reviewers will check for:
36+
37+
- **Functionality**: Does the code work as intended?
38+
- **Security**: Are there any security vulnerabilities?
39+
- **Performance**: Will this impact system performance?
40+
- **Accessibility**: Does this maintain accessibility standards?
41+
- **Maintainability**: Is the code readable and maintainable?
42+
- **Testing**: Are there adequate tests?
43+
44+
### Addressing Feedback
45+
46+
- Respond promptly to review comments
47+
- Make requested changes or discuss alternatives
48+
- Update tests and documentation as needed
49+
- Re-request review after making changes
50+
51+
Thank you for contributing to the Nava Strata!

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,12 @@ project to use a newer version of this template:
7575
```sh
7676
nava-platform app update . <APP_NAME>
7777
```
78+
## License
79+
80+
This project is licensed under the Apache 2.0 License. See the [LICENSE](LICENSE) file for details.
81+
82+
## Community
83+
84+
- [Code of Conduct](CODE_OF_CONDUCT.md)
85+
- [Contributing Guidelines](CONTRIBUTING.MD)
86+
- [Security Policy](SECURITY.md)

0 commit comments

Comments
 (0)