Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.87 KB

ISSUE_GUIDELINES.md

File metadata and controls

55 lines (36 loc) · 2.87 KB
Raw

Issue Report Guidelines

👍🎉 Thanks for taking the time to contribute! 🎉👍

In order to give everyone a chance to submit a issues reports and contribute to the project, we have put restrictions in place. This section outlines the guidelines that should be imposed upon issue reports in the project.

Table of Contents

Issue Management

In all cases please use the GitHub open issue search to check whether the issue has already been reported.

New Issues

To create new issues follow these steps:

  1. Your issue may have already been created. Search for duplicate open issues before submitting yours, for similar deficiencies in the code - duplicate issues are created.
  2. Verify whether the issue has been fixed by trying to reproduce it using the latest master or development branch in the repository.
  3. Click on the New Issue button
  4. Use the templates to create a standardized report of what needs to be done and why.
  5. If you want to be assigned the issue that you have created, then add a comment immediately after submitting it.

We welcome contributors who find new ways to make the code better.

Existing Issues

You can also be a valuable contributor by searching for dormant issues. Here's how you can do that:

  1. Previously Assigned Issues: We regularly review issues and add a no-issue-activity label to them. Use the issue comments to ask whether the assignee is still working on the issue, and if not, ask for the issue to be assigned to you.
  2. Unassigned Issues: If the issue is already reported and not assigned to anyone and you are interested in working on the issue then:
    1. Ask for the issue to be assigned to you in the issue comments
    2. Ask our team to assign it to you on discord.

Working on these types of existing issues is a good way of getting started with the community.

Feature Request Issues

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the mentors of the merits of this feature. Please provide as much detail and context as possible.

General Guidelines

  1. Discuss issues in our various discord channels when necessary
  2. Please do not derail or troll issues.
  3. Keep the discussion on topic and respect the opinions of others.