Skip to content

feat(contributing): generate a CONTRIBUTING.md document #10

@gregswindle

Description

@gregswindle

1. Issue type

⌦ Type the letter "x" in the "checkbox" the best describe this issue.

  • Feature: I'm requesting a product enhancement.

2. User story summary

As a repository maintainer,
I need to have a CONTRIBUTING.md document
In order to assist those who want to contribute.

3. Acceptance criteria

  • 1. Maintainers are prompted for their Git branching workflow (feature-branch, Gitflow, or "other")
  • 2. Maintainers are prompted for a URL to their code standards and name (if applicable).
  • 3. Maintainers are prompted for the name and URL to their linter.
  • 4. Maintainers are prompted for their unit testing framework name and URL.
  • 5. Maintainers are prompted for their unit testing Statement, Branch, Method, and Line coverage thresholds.
  • 6. Maintainers are prompted for the name of their Logging library and its URL.
  • 7. Maintainers are prompted for their conventional commit message style (jQuery or Angular).
  • 8. Maintainers are prompted for their product's programing language.
  • 9. Maintainers are prompted for their product's dependency manager.
  • 10. Maintainers are prompted for the path to their product manifest.
  • 11. Maintainers are asked whether to include a section for RESTful APIs.
  • 12. A CONTRIBUTING.md document is generated based on the answers provided.
  • 13. The README.md document has been updated to reflect new features.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions