How to file issues

Simpler.Grants.gov uses GitHub as our primary work tracker. If you encounter bugs, have feature requests, or want to provide feedback, filing an issue on GitHub is the way to go. This guide will help you understand how to file issues and contribute to improving our projects.

Getting Started

Make sure that all issues follow the Simpler.Grants.gov Code of Conduct. We understand that experiencing issues with software can be frustrating, especially when it prevents you from doing work. However, please remember that a human on the other side will be reading your issue and responding to it.

1. Navigate to Issues

• Go to the repository on GitHub where you want to file the issue.

2. Click on "Issues"

• Click on the "Issues" tab at the top of the repository to view existing issues or file a new one.

3. Check Existing Issues

• Before filing a new issue, check if a similar issue has already been reported.

• If you find a similar issue, instead of creating a new one, react to the existing one with a thumbs up and comment if you have any additional insights.

Filing a New Issue

1. Click on "New Issue"

• Click the green "New Issue" button to create a new issue.

2. Choose Issue Template (if available)

• Some repositories may provide issue templates to help standardize the information provided.

• Choose the appropriate template.

Type	Details
Bug Report	Used for filing reports of existing features in the software not working as expected
Feature Request	Used for creating a request to add a feature that is currently not supported within the software
Report a security vulnerability	Used to report a software security issue that you have noticed.

3. Submit the Issue

• Once you've filled out all the necessary information, click the "Submit new issue" button to create the issue.

• We will review the issue and prioritize it within the Simpler Grants Community. We may not respond immediately or directly to you, but we review all issues and appreciate your participation and patience.

Tips for Filing Issues

• Be descriptive: Provide as much information as possible to help developers understand and address the issue.

• Search first: Before filing a new issue, search existing issues to avoid duplicates.

• Follow guidelines: If the repository has specific guidelines or templates for filing issues, follow them for consistency.

Change log

Major updates to the content of this page will be added here.

Date	Update	Notes
2/12/2024	Initial Content	Updated with Initial content