[ETL-574] Add CONTRIBUTING.md #91
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BryanFauble
reviewed
Nov 13, 2023
CONTRIBUTING.md
Outdated
| 1. Clone this repository (do not fork). Create a feature branch off the `main` branch. Branch names must contain the identifier of the corresponding Jira ticket (e.g., `etl-574`). Optionally, add keywords describing the work that is being done to the branch name (e.g., `etl-574-add-contributing-doc`). | ||
|
|
||
| > [!IMPORTANT] | ||
| > Keep branch names as short as possible. We use the branch name to namespace resources in AWS (as described below). Since AWS imposes limits on the name length of some resources, the deployment may fail if the branch name is too long. |
There was a problem hiding this comment.
IIRC capital letters in the branch name also causes issues
There was a problem hiding this comment.
I couldn't find a good reference for safe characters in AWS resource names, so I added a generic disclaimer about using safe characters ([a-z], hyphen, underscore)
BryanFauble
reviewed
Nov 13, 2023
CONTRIBUTING.md
Outdated
| pipenv install --dev | ||
| ``` | ||
|
|
||
| from the repository root to create a virtual environment and install all dependencies. |
There was a problem hiding this comment.
The formatting ended up a little poor here when looking at the rendered md - Ideally this should maintain the same indent level:
There was a problem hiding this comment.
I don't know if it's possible to put code blocks at an indent level, so I moved the code block to the bottom of point 2 so the formatting is less jarring.
BryanFauble
reviewed
Nov 13, 2023
BryanFauble
reviewed
Nov 13, 2023
BryanFauble
reviewed
Nov 13, 2023
BryanFauble
approved these changes
Nov 13, 2023
thomasyu888
approved these changes
Nov 14, 2023
philerooski
had a problem deploying
to
develop
GitHub Actions
Failure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Things to look out for: