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

Add CONTRIBUTING.md #103

Merged
merged 8 commits into from
Oct 9, 2021
Merged

Add CONTRIBUTING.md #103

merged 8 commits into from
Oct 9, 2021

Conversation

RothAndrew
Copy link
Member

@RothAndrew RothAndrew commented Oct 8, 2021

What/Why

  • Add CONTRIBUTING.md, with the primary objective for now being to document the Terratest-based E2E stuff

Fixes #96

@RothAndrew RothAndrew self-assigned this Oct 8, 2021
@RothAndrew
Copy link
Member Author

/cc @btlghrants - visibility & collaboration on the other documentation work you're doing.

@btlghrants
Copy link
Contributor

btlghrants commented Oct 8, 2021

This here's a few things I had lined-up to figure out & include in our "how to contribute" stuff. Perhaps you'll get to 'em first?

  • We have a PR + 1 reviewer policy.

    • branches or forks?
  • We use signed commits (link gpg setup instructions)!

  • After review approval, who merges & what kind of merge is the "default": Merge Commit, Squash & merge, or Rebase & merge?

  • We like Draft PRs.

@RothAndrew
Copy link
Member Author

@btlghrants I'm ready for you to take a gander at it when you feel like doing so. Still working on it a bit more so not ready to put it out for review but I'm feeling like I've got some good stuff in there now that I can get feedback on.

@RothAndrew RothAndrew added the documentation 📘 Improvements or additions to documentation label Oct 8, 2021
@RothAndrew RothAndrew marked this pull request as ready for review October 8, 2021 22:52
@RothAndrew
Copy link
Member Author

/test all

Copy link
Member

@jeff-mccoy jeff-mccoy left a comment

Choose a reason for hiding this comment

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

I think this is a great start. Personally I'm fine with fork or branch, depending on the dev's role within the team. We can always enhance more later, but I think this is great start.

@jeff-mccoy jeff-mccoy merged commit 4ef1539 into master Oct 9, 2021
@jeff-mccoy jeff-mccoy deleted the feature/docs-for-e2e-tests branch October 9, 2021 20:22
jeff-mccoy pushed a commit that referenced this pull request Feb 8, 2022
Closes #103

Signed-off-by: Jeff McCoy <code@jeffm.us>
Noxsios pushed a commit that referenced this pull request Mar 8, 2023
Closes #103

Signed-off-by: Jeff McCoy <code@jeffm.us>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs for new Terratest E2E GitHub Actions stuff
3 participants