Skip to content

Commit

Permalink
add commit instructions/clarification to env setup doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aasserzo committed Feb 17, 2025
1 parent d80c0a2 commit ee8afb8
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/prepare-your-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ Make sure that `PKG_CONFIG_PATH` contains the pkgconfig files of the above packa
make init-contrib
git config --global github.user <<user_name>>
```
- **NOTE**: ```make init-contrib``` will enforce a branch naming regex on your commits.
# Troubleshooting
Expand All @@ -180,6 +181,13 @@ To resolve, run `SECRET_SA_ACCOUNT_NAME=rharosecretsdev make secrets`.
- `az -v` does not return `aro` as dependency.
To resolve, make sure it is being used the `env` file parameters as per the `env.example`
- If you get the following error when running `git commit`
```bash
There is something wrong with your branch name. Branch names in this project must adhere to this contract: ^${USERNAME}\/(ARO-[0-9]{4}[a-z0-9._-]*|hotfix-[a-z0-9._-]+|gh-issue-[0-9]+[a-z0-9._-]*)$. Your commit will be rejected. Please rename your branch (git branch --move) to a valid name and try again.
```
Make sure you adhere to the rule, unless the PR is not tied to a Jira ticket, a GitHub issue or a hotfix. For those cases you can append `--no-verify` to your `git commit` command.
## Getting Started with Docker Compose
1. Install [Docker Compose](https://docs.docker.com/compose/install/linux/#install-using-the-repository)
Expand Down

0 comments on commit ee8afb8

Please sign in to comment.