Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(developer-guide): create ERB templates #5

Open
13 tasks
gregswindle opened this issue Jun 26, 2018 · 0 comments
Open
13 tasks

docs(developer-guide): create ERB templates #5

gregswindle opened this issue Jun 26, 2018 · 0 comments
Assignees
Labels
priority: medium status: accepted status: available type: docs Add, edit, or delete instructional material type: feature New feature or request

Comments

@gregswindle
Copy link
Contributor

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

....

@gregswindle gregswindle added type: feature New feature or request status: available status: accepted type: docs Add, edit, or delete instructional material priority: medium labels Jun 26, 2018
@gregswindle gregswindle self-assigned this Jun 26, 2018
@gregswindle gregswindle added this to To do in Initial release v1.0.0 via automation Jun 26, 2018
gregswindle added a commit that referenced this issue Jun 26, 2018
1. README
2. ADR workflow
3. API guidelines

GH-5
gregswindle added a commit that referenced this issue Jun 29, 2018
Work with executives to designate governance organizationally and
within InnerSource teams.

#5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: medium status: accepted status: available type: docs Add, edit, or delete instructional material type: feature New feature or request
Projects
Development

No branches or pull requests

1 participant