Open
Description
1. User story: summary of expected behavior
⌦ Describe what you want to accomplish, in what role/capacity,
⌦ and why it's important to you.
As a potential contributor,
I want source code development guidelines
In order to increase the likelihood of contributing changes.
2. Acceptance criteria
We'll be done when:
- 1. A succinct README provides:
- 1.1. Recommended skills
- 1.2. Development software requirements
- 1.3. Source code retrieval instructions
- 1.4. Dependency installation and update instructions
- 1.5. Build instructions
- 1.6. Test execution instructions
- 1.7. Source code style guidelines
- 1.8. DevSecOps overview
- 2. A debugging doc with set up and execution instructions exists
- 3. A document with API design, security, and documentation guidelines exists
- 4. A document exists covering Architecture Decision Records (ADR): process, submission, and maintainer instructions
- 5. A copy of (or link to) Codacy's Software metrics: a practical guide for the curious developer PDF exists.
3. Notes
....