Simpler.Grants.gov Public Wiki
Grants.govSimpler.Grants.govGitHubDiscourse
  • 👋Welcome
  • GET INVOLVED
    • Why open source?
    • How to contribute code
    • How to file issues
      • Report a bug
      • Request a feature
      • Report a security vulnerability
    • Community guidelines
      • Code of Conduct
      • Reporting and removing content
      • Incident response protocol
    • Community events
      • Fall 2024 Coding Challenge
        • Event Submissions & Winners
      • Spring 2025 Collaborative Coding Challenge
        • Event Submissions & Winners
    • Communication channels
  • Product
    • Roadmap
    • Deliverables
      • 🏁Static site soft launch
      • 🏁Static site public launch
      • 🏁GET Opportunities
      • 🏁Open source onboarding
      • 🏁Co-Design Group planning
    • Decisions
      • ADR Template
      • ADRs
        • Dedicated Forum for Simpler.Grants.gov Community
        • Recording Architecture Decisions
        • Task Runner for the CI / CD Pipeline
        • API Language
        • Use Figma for design prototyping
        • ADR: Chat
        • DB Choices
        • API Framework and Libraries
        • Back-end Code Quality Tools
        • Front-end Language
        • Communications Tooling: Wiki Platform
        • Use Mural for design diagrams and whiteboarding
        • Ticket Tracking
        • Front-end Framework
        • Front-end Code Quality Tools
        • Front-end Testing & Coverage
        • Backend API Type
        • Front-end Testing & Coverage
        • Deployment Strategy
        • Use U.S. Web Design System for components and utility classes
        • FE server rendering
        • Use NPM over Yarn Architectural Decision Records
        • U.S. Web Design System in React
        • Communications Tooling: Video Conferencing
        • Back-end Production Server
        • Communications Tooling: Analytics Platform
        • Commit and Branch Conventions and Release Workflow
        • Cloud Platform to Host the Project
        • Infrastructure as Code Tool
        • Data Replication Strategy & Tool
        • HHS Communications Site
        • Communications Tooling: Email Marketing
        • Communications Tooling: Listserv
        • Use Ethnio for design research
        • Uptime Monitoring
        • Database Migrations
        • 30k ft deliverable reporting strategy
        • Public measurement dashboard architecture
        • Method and technology for "Contact Us" CTA
        • E2E / Integration Testing Framework
        • Logging and Monitoring Platform
        • Dashboard Data Storage
        • Dashboard Data Tool
        • Search Engine
        • Document Storage
        • Document Sharing
        • Internal Wiki ADR
        • Shared Team Calendar Platform
        • Cross-Program Team Health Survey Tool
        • Adding Slack Users to SimplerGrants Slack Workspace
        • Repo organization
        • Internal knowledge management
        • Migrate Existing API Consumers
      • Infra
        • Use markdown architectural decision records
        • CI/CD interface
        • Use custom implementation of GitHub OIDC
        • Manage ECR in prod account module
        • Separate terraform backend configs into separate config files
        • Database module design
        • Provision database users with serverless function
        • Database migration architecture
        • Consolidate infra config from tfvars files into config module
        • Environment use cases
        • Production networking long term state
    • Analytics
      • Open source community metrics
      • API metrics
  • DESIGN & RESEARCH
    • Brand guidelines
      • Logo
      • Colors
      • Grid and composition
      • Typography
      • Iconography
      • Photos and illustrations
    • Content guidelines
      • Voice and tone
    • User research
      • Grants.gov archetypes
  • REFERENCES
    • Glossary
  • How to edit the wiki
Powered by GitBook
On this page
  • Getting Started
  • 1. Navigate to Issues
  • 2. Click on "Issues"
  • 3. Check Existing Issues
  • Filing a New Issue
  • 1. Click on "New Issue"
  • 2. Choose Issue Template (if available)
  • 3. Submit the Issue
  • Tips for Filing Issues
  • Change log

Was this helpful?

Edit on GitHub
  1. GET INVOLVED

How to file issues

PreviousHow to contribute codeNextReport a bug

Last updated 2 months ago

Was this helpful?

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 . 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

Used for filing reports of existing features in the software not working as expected

Used for creating a request to add a feature that is currently not supported within the software

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

Code of Conduct
Bug Report
Feature Request
Report a security vulnerability