Document your code
Every project on GitHub comes with a version-controlled wiki to give your documentation the high level of care it deserves. It’s easy to create well-maintained, Markdown or rich text documentation alongside your code.
Sign up for free See pricing for teams and enterprisesCreating an issue
- An issue should exist for every change and every pull request.
- Issues should usually follow the issue template.
- Issues must be actionable. If a developer cannot read it and take action on it, then the issue is likely too vague and needs some higher level planning before going into GitHub.