Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.81 KB

CONTRIBUTING.md

File metadata and controls

33 lines (20 loc) · 1.81 KB

Contributing

What not to commit to the repo

There are a handful of things we do not commit to the repository:

  • Information about particular vendors or procurement information
  • Anything related to PII whether it is from user interviews or feedback
  • User research related scheduling or documentation
  • Compliance documentation that includes IP addresses
  • Secrets of any kind

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.

Project Management

We use Github Projects for project management and tracking.

Github Project Board

We maintain an internal Github Project Board for tracking issues across .gov related repositories. Draft issues in the board are private and any project related issues are public.

Labeling system

Every issue in this respository and on the project board should be appropriately labeled. Each sprint we identify one or more epic issues that express our goals for the sprint. Within the epic we document all related issues that must be shipped for the epic to move to done.

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.