Skip to content
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.

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

Update PR template and presentation of environment variables in README #16

Merged
merged 2 commits into from
Feb 12, 2024

Conversation

jonavellecuerdo
Copy link
Contributor

@jonavellecuerdo jonavellecuerdo commented Feb 9, 2024

Purpose and background context

Clarify language for "Code Reviewer" check list in PR template and update "Environment variables" section in README to make use of code blocks.

  • PR template: The updated language relaxes the requirement for Code Reviewers to rerun manual tests that are difficult to execute as long as the Developer provides clear examples (i.e., screenshots, links) that can be verified (e.g., by logging into the AWS consoles and reviewing created outputs).
  • README: Reflect our current practices for documenting environment variables in README.

Includes new or updated dependencies?

NO

Changes expectations for external applications?

NO

What are the relevant tickets?

Developer

  • All new ENV is documented in README
  • All new ENV has been added to staging and production environments
  • All related Jira tickets are linked in commit message(s)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer(s)

  • The commit message is clear and follows our guidelines (not just this PR message)
  • There are appropriate tests covering any new functionality
  • The provided documentation is sufficient for understanding any new functionality introduced
  • Any manual tests have been performed or provided examples verified
  • New dependencies are appropriate or there were no changes

@jonavellecuerdo jonavellecuerdo self-assigned this Feb 9, 2024
@coveralls
Copy link

Pull Request Test Coverage Report for Build 7849186829

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 7819921165: 0.0%
Covered Lines: 36
Relevant Lines: 36

💛 - Coveralls

@jonavellecuerdo jonavellecuerdo marked this pull request as ready for review February 9, 2024 21:09
@jonavellecuerdo jonavellecuerdo merged commit e252fa2 into main Feb 12, 2024
2 checks passed
@jonavellecuerdo jonavellecuerdo deleted the update-pr-template branch February 12, 2024 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants