development-guide icon indicating copy to clipboard operation
development-guide copied to clipboard

A set of guidelines and best practices for an awesome engineering team

Results 28 development-guide issues
Sort by recently updated
recently updated
newest added

Bumps [actions/setup-go](https://github.com/actions/setup-go) from 2 to 3. Release notes Sourced from actions/setup-go's releases. v3.0.0 What's Changed Update default runtime to node16 (actions/setup-go#192) Update package-lock.json file version to 2 (actions/setup-go#193) and @types/node...

dependencies
github_actions

Bumps [hashicorp/setup-terraform](https://github.com/hashicorp/setup-terraform) from 1 to 2. Release notes Sourced from hashicorp/setup-terraform's releases. v2.0.0 What's Changed NOTES docs: update existing PR comments example by @​tobiasbueschel in hashicorp/setup-terraform#178 Update Terraform versions and...

dependencies
github_actions

# 💡 Summary # We should add to the development guide an explanation for why for Python package installation steps we typically lead with ```console python -m pip install --upgrade...

documentation
improvement

# 💡 Summary # We should come to consensus on various Terraform-related coding/naming conventions and document them. ## Motivation and context ## In https://github.com/cisagov/cool-assessment-terraform/pull/153 there was some discussion about how...

documentation
improvement
need info

# 🐛 Summary # The current information in [branch-protection.md](https://github.com/cisagov/development-guide/blob/develop/project_setup/branch-protection.md) about configuring required tests in branch protection settings no longer reflects the GitHub UI. The description should be updated to reflect...

bug
documentation

# 🐛 Summary # When working on #57 I noticed that the section headings in `project-setup/branch-protection.md` are inconsistent. Some use a gerund phrase (e.g. "Selecting a skeleton") while others use...

documentation

# 💡 Summary # Break out all of the Markdown specific guidelines in `style-guide.md` into an appropriate `languages/markdown` section. ## Motivation and context ## Currently the information in `style-guide.md` contains...

documentation
improvement

# 💡 Summary # We should have a style guide for Terraform (HCL) code just as we do for Python. ## Motivation and context ## It's currently more just team...

documentation
improvement

That is a good point, although we devs tend to have a hard time knowing or remembering what normies know and don't know. It's definitely something to keep in mind...

# 💡 Summary # Add some documentation for how to set up common tools for a development environment on Windows. ## Motivation and context ## Several people who work with...

documentation