Create an issue / PR template that makes sense for documentation
Open
Nobody has claimed this yet.
PR
- Dominant language
- Makefile
- Stars
- 67
- Forks
- 94
- Avg merge
- 5h 51m
- Merged PRs (30d)
- 1
Description
This should loosely model the templates used for the "faas" repo but have specific questions / prompts which relate to adding documentation.
Checkpoints may include:
- I have tested the markdown appearance with Docker
- I have tested any new instructions
- I am the author or have permission to share this text and reference the source
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing issue and pull-request templates in the faas repository, then identify where this repository keeps its templates. Add documentation-specific questions and the listed checkpoints, including Markdown rendering, instruction testing, and text permissions. Done means contributors can use both templates to provide the requested documentation context.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100