From b5de2655cd574c01b99d1e6a8f2f9ef4b0eb3dbd Mon Sep 17 00:00:00 2001 From: Jenn Stein <72215763+jennstein2017@users.noreply.github.com> Date: Sun, 24 Sep 2023 16:15:07 -0400 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 266d0c42d..3b63a61ff 100755 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ Challenge.Gov is an open source platform that accepts contributions and feedback from our customers. -**Code of Conduct** +## Code of Conduct Challenge.Gov is committed to building a safe, welcoming, harassment-free culture for everyone. Challenge.Gov is a part of the Technology Transformation Services (TTS) within the General Services Administration (GSA), and we expect everyone to follow the [GSA TTS Code of Conduct](https://handbook.tts.gsa.gov/about-us/code-of-conduct/). We encourage you to read this platform’s [DEVCONFIG](DEVCONFIG.md), its [LICENSE]( https://github.com/GSA/Challenge_gov/blob/main/LICENSE), and its [README](README.md). If you want to read more about our open source policy or have questions, check out the GSA’s Open Source Policy (https://open.gsa.gov/oss/ or send us an [email](mailto:team@challenge.gov). -**How you can contribute** +## How you can contribute Anyone can contribute to Challenge.Gov. Whether it's notifying us of an issue, proposing a new feature, or suggestions for content or workflow improvements, we welcome your ideas on how to improve this site. @@ -14,13 +14,13 @@ First time contributor? We’re here to help guide you through a successful cont Before submitting a contribution, you’ll just need to create a GitHub account or sign in to your existing account. -**Submitting bugs and issues** +## Submitting bugs and issues If something isn’t working the way it's supposed to: Email (mailto:team@Challenge.Gov) and document how to reproduce the bug. Before submitting a bug, try to recreate it and document the steps we can take to reproduce it. If you can, take screen shots to capture specific details about the bug. This helps us understand its context. We can only fix bugs that we're able to understand and reproduce. -**To Contribute to fixing bugs, developing features and enhancements:** +## To Contribute to fixing bugs, developing features and enhancements Before submitting a contribution, you’ll just need to create a GitHub account or sign in to your existing account. @@ -31,7 +31,7 @@ Submit your pull request against the `main` branch. If the pull request is accepted, we will merge the pull request for you. -**How we prioritize** +## How we prioritize Once you’ve submitted a contribution, we'll review the code and triage it based on the following considerations: 1. **Severity:** What type of functionality is impacted? Is there a workaround? @@ -42,7 +42,7 @@ Note: We prioritize issues that affect accessibility, user experience, and syste These considerations help us decide if and when we can work on the issue. If the issue is accepted, we will schedule them for an upcoming 2-week sprint. -**Common terms** +## Common terms There can be a lot of jargon when discussing how you can contribute to Challenge.Gov. We’ve included some common terms we use below.