From 23f6b0658ebde50e123c665587e40356d56490b0 Mon Sep 17 00:00:00 2001 From: Erin Song <121973038+erinysong@users.noreply.github.com> Date: Thu, 22 May 2025 09:11:00 -0700 Subject: [PATCH] Update contributing.md (#3815) * Update contributing docs * Reformat HTML file to prompt github runners --- CONTRIBUTING.md | 7 ++----- src/registrar/templates/base.html | 1 - 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbe366470..6deb91de5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,8 +11,8 @@ There are a handful of things we do not commit to the repository: ## Branch naming convention -For developers, you can auto-deploy your code to your sandbox (if applicable) by naming your branch thusly: jsd/123-feature-description -Where 'jsd' stands for your initials and sandbox environment name (if you were called John Smith Doe), and 123 matches the ticket number if applicable. +Name your branches in the format `your_initials/issue_number-description`. For example: `ab/1234-update-documentation`. +If your branch name starts with `your_initials/`, the (deploy-sandbox)[.github/workflows/deploy-sandbox.yaml] workflow will auto-deploy your pushed branch code to your sandbox if your branch has a PR. ## Project Management @@ -28,6 +28,3 @@ Every issue in this respository and on the project board should be appropriately We also have labels for each discipline and for research and project management related tasks. While this repository and project board track development work, we try to document all work related to the project here as well. -## Branch Naming - -Our branch naming convention is `name/issue_no-description`, for example: `lmm/1234-add-contributing-doc`. diff --git a/src/registrar/templates/base.html b/src/registrar/templates/base.html index dd6417ccb..55af9b94b 100644 --- a/src/registrar/templates/base.html +++ b/src/registrar/templates/base.html @@ -54,7 +54,6 @@ {% endblock %} - {% block feeds %}{% endblock %} {% block extra_head %}{% endblock %}