Skip to content

Feat: added explanation for creation of new issue to CONTRIBUTING.md #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Feat: added explanation for creation of new issue to CONTRIBUTING.md #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,25 @@ Use the issue tracker to find ways to contribute. Find a bug or a feature, menti
the issue that you will take on that effort, then follow the _Changing the code-base_
guidance below.

## High level reasnoning for creating a new issue

Creating a new issue serves as a structured way to report problems, suggest enhancements, or ask questions related to a project. At a high level, the purpose of an issue is to facilitate clear communication between contributors, maintainers, and users to ensure the project remains functional, user-friendly, and continuously improving. Key reasons include


Bug Reports – Identifying unexpected behavior, errors, or broken functionality that negatively impact the project. A well-documented issue helps developers diagnose and fix the problem efficiently.

Feature Requests – Suggesting new functionalities that could improve user experience, performance, or usability. Clearly defining the feature ensures that it aligns with the project's vision and goals.

Enhancements & Optimizations – Proposing improvements to existing code, performance optimizations, or updates that refine the project’s efficiency and maintainability.

Documentation Issues – Reporting missing, unclear, or outdated documentation that could create confusion for users and contributors.

Security Vulnerabilities – Notifying maintainers about potential security risks that need immediate attention to protect users and data integrity.

Questions & Discussions – Seeking clarification on project implementation, guidelines, or best practices to ensure proper usage and contribution.

By creating a well-structured issue, contributors and maintainers can collaborate effectively, prioritize tasks, and drive meaningful improvements while keeping the project organized and transparent.


## Changing the code-base

Expand All @@ -42,3 +61,4 @@ to support a reasonable set of backward compatibility with older browsers.
Please read up on
[our current browser support guidance](https://github.com/cfpb/development/blob/main/guides/browser-support.md)
and follow it when contributing to this project.