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

HCPE-996 - Add pull request lifecycle docs #89

Merged
merged 1 commit into from
Mar 29, 2021
Merged

Conversation

roaks3
Copy link
Contributor

@roaks3 roaks3 commented Mar 26, 2021

πŸ› οΈ Description

Added docs to describe the PR lifecycle, meant primarily for new contributors.

πŸ—οΈ Acceptance tests

  • Are there any feature flags that are required to use this functionality?
  • Have you added an acceptance test for the functionality being added?
  • Have you run the acceptance tests on this branch?

Output from acceptance testing:

$ make testacc TESTARGS='-run=TestAccXXX'

...

@roaks3 roaks3 requested a review from a team March 26, 2021 17:00
@@ -0,0 +1,46 @@
# Pull Request Submission and Lifecycle
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of this content is sourced from other repos: Kubernetes provider, AWS provider

Comment on lines +3 to +7
__Note for internal service teams__: The pull request lifecycle below will be
roughly the same for internal teams, but you will not need to fork the repo to
create pull requests, and our recommendation is to get a review from one other
member of your service team, in addition to a review from one member of the
provider team.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main note I added to address internal team members

Comment on lines +41 to +43
releasing new versions of the provider. Please ask a provider team member
about the timing of the next release if the change you are making is
time-sensitive. Generally, releases are done roughly every two weeks.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These sentences at the end were added to set expectations for contributors on when their changes will be released (mainly aimed toward internal teams that have their own timelines to work with)

@roaks3 roaks3 force-pushed the HCPE-996-pr-lifecycle branch from cb27906 to 2d7c15f Compare March 26, 2021 17:06
@roaks3 roaks3 changed the title Add pull request lifecycle docs HCPE-996 - Add pull request lifecycle docs Mar 26, 2021
Copy link
Contributor

@bcmdarroch bcmdarroch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! πŸ‘ πŸ‘

@roaks3 roaks3 merged commit 5a9d9cd into main Mar 29, 2021
@roaks3 roaks3 deleted the HCPE-996-pr-lifecycle branch March 29, 2021 15:06
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.

2 participants