Skip to content

Commit b08eb6a

Browse files
authored
Revise contribution steps for branch naming and CI (#818)
* Revise contribution steps for branch naming and CI Updated contribution guidelines to reflect branch naming changes and added a note about running Actions. * Apply suggestion from @babenek
1 parent 88ca3ed commit b08eb6a

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/howto/how-to-contribute.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,9 @@ After updating CredSweeper code, please verify your change doesn't break the lib
5555
```
5656

5757
Please make it sure running all tests and no any fail case.
58+
Run all Actions in your fork before submitting the PR to the upstream and ensure all CI checks pass.
5859

59-
**Step 4:** Submit a Pull Request (PR) from your branch to `Samsung/CredSweeper/master`.
60+
**Step 4:** Submit a Pull Request (PR) from your branch to `Samsung/CredSweeper/main`.
6061

6162
Each PR should usually address one issue at a time. The PR can modify one or multiple files. If you're addressing multiple fixes on different files, separate PRs are preferred.
6263

@@ -66,7 +67,7 @@ The CredSweeper team will review your PR and let you know if there are any other
6667

6768
**Step 5:** Make any necessary updates to your branch as discussed with the team.
6869

69-
The maintainers will merge your PR into the master branch once feedback has been applied and your change is approved.
70+
The maintainers will merge your PR into the main branch once feedback has been applied and your change is approved.
7071

7172

7273
### How to PR

0 commit comments

Comments
 (0)