@@ -93,7 +93,7 @@ By default, this tool will include a long list of contributors at the end of you
9393
9494(how-does-this-tool-define-contributions-in-the-reports)=
9595
96- ### How we define contributors a changelog
96+ ### How we define contributors in a changelog
9797
9898GitHub Activity tries to automatically determine the unique list of contributors within a given window of time.
9999There are many ways to define this, and there isn't necessarily a "correct" method out there.
@@ -103,7 +103,7 @@ We've chosen a few rules that try to reflect sustained engagement in issues/PRs,
103103
104104Here are the rules we follow for finding a list of contributors within a time window. A contributor is anyone who has:
105105
106- - Contributed to a PR merged in that window (includes opening, merging, committing, commenting, or committing )
106+ - Contributed to a PR merged in that window (includes opening, merging, committing, or commenting )
107107- Commented on >= 2 issues that weren't theirs
108108- Commented >= 6 times on any one issue
109109- Known bot accounts are generally not considered contributors
@@ -130,7 +130,7 @@ To include closed issues in your changelog, use the `--include-issues` flag.
130130
131131## Include opened issues in your changelog
132132
133- To include issues and Pull Requests that were _ opened_ in a time period, use teh ` --include-opened ` flag.
133+ To include Issues and Pull Requests that were _ opened_ in a time period, use the ` --include-opened ` flag.
134134
135135(use: token )=
136136
@@ -187,12 +187,14 @@ markdown = generate_activity_md(
187187 target="executablebooks/github-activity",
188188 since="2023-01-01",
189189 until="2023-12-31",
190- auth="your-github-token",
191190 kind=None,
191+ auth="your-github-token",
192+ tags=None,
192193 include_issues=True,
193194 include_opened=True,
194195 strip_brackets=True,
195- heading_level=1
196+ heading_level=1,
197+ branch=None,
196198)
197199
198200# Print or save the markdown
0 commit comments