Skip to content

Commit 5ec6f03

Browse files
committed
trigger workflow when PR is merged to main
1 parent 72a0dea commit 5ec6f03

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

.github/workflows/main.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License
1414

15-
#TODO: Update 'on' to be conditional per job
16-
on: push
15+
# This will trigger the workflow to run whenever a PR is merged to the main branch
16+
on:
17+
push:
18+
branches:
19+
- main
1720

1821
jobs:
1922
test:

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ This is a code linter that checks for biased language in a code repository. Curr
66
2. [Developer Instructions](#developer-instructions)
77
3. [Usage Example](#usage-example)
88
4. [Excluding directories and files](#excluding-directories-and-files)
9-
5. [FAQ](#frequently-asked-questions)
9+
5. [Propose new biased words](#proposing-new-biased-words)
10+
6. [FAQ](#frequently-asked-questions)
1011

1112
# Quickstart
1213

@@ -137,7 +138,11 @@ python3 run_json.py --mode=check --path=/user/jdoe/git/myProject
137138

138139
## Formatting of word_list.csv
139140

140-
The biased words are listed on a new line. If you would like to propose a new biased word, we will need to
141+
The biased words are listed on a new line in the `word_list.csv` file.
142+
143+
## Proposing new biased words
144+
145+
TBD
141146

142147
## Excluding directories and files
143148

@@ -163,4 +168,4 @@ If the pipeline detects biased language anywhere in the repository, the `biased_
163168

164169
## Learn More
165170

166-
- Write Unbiased Documentation: [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Inclusivity)
171+
- Bias Free Communication: [Splunk Style Guide](https://docs.splunk.com/Documentation/StyleGuide/current/StyleGuide/Inclusivity)

0 commit comments

Comments
 (0)