Search code examples
githubissue-tracking

How should I provide guidelines for issues? (Github)

I want to give the users of my repository some info on how they should report issues and what info they should provide. What is the best way to present this information, and where? I was hoping there would be a readme on the /issues tab but there seems no such option. Maybe I should create an 'issue' named 'Read before creating issue'?

Solution

  • If you're worried about the added clutter in the root directory of your project.
    You can put CONTRIBUTING.md, ISSUE_TEMPLATE.md, and PULL_REQUEST_TEMPLATE.md files in the project directory.
    Yes, it will easy both parties to creating the issue or pull request fill all info.

    see in the pic

    What is the best way to present this information, and where?

    Put it into your this three files and file name should be same as here. More information about it