You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributor-insights.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,19 +32,19 @@ The action protects contributor privacy by not supplying any information that is
32
32
Interested in implementing the contributors action in your project or organization? Here's a step-by-step guide to get you started:
33
33
34
34
1. Create a Repository
35
-
Start by creating a new repository to host the contributors GitHub action or select an existing one. You can also run this action on an entire organization.
35
+
Start by creating a new repository to host the contributors GitHub action or select an existing one. You can also run this action on an entire organization.
36
36
37
37
2. Choose an Example Workflow
38
-
Select the best-fit workflow file from the [examples](https://github.com/github/contributors/blob/main/README.md#example-workflow) provided and customize it to your needs with the ["Configuration" section of the contributors action README.md file](https://github.com/github/contributors/blob/main/README.md#configuration).
38
+
Select the best-fit workflow file from the [examples](https://github.com/github/contributors/blob/main/README.md#example-workflow) provided and customize it to your needs with the ["Configuration" section of the contributors action README.md file](https://github.com/github/contributors/blob/main/README.md#configuration).
39
39
40
40
3. Copy and Edit the Workflow
41
-
Copy the chosen example workflow into your repository and save it in the .github/workflows/ directory with the .yml file extension. Edit the values in the workflow to match your specific needs, including the organization or repository you want to measure, start and end dates (if applicable), and other configurations.
41
+
Copy the chosen example workflow into your repository and save it in the .github/workflows/ directory with the .yml file extension. Edit the values in the workflow to match your specific needs, including the organization or repository you want to measure, start and end dates (if applicable), and other configurations.
42
42
43
43
4. Set the GitHub Token
44
-
Ensure that you have a GitHub Token with the necessary permissions to read the repository or organization you're interested in scanning. If you're running the Action on a different repository or organization, create a GitHub API token and store it as a repository secret, referencing it in your workflow.
44
+
Ensure that you have a GitHub Token with the necessary permissions to read the repository or organization you're interested in scanning. If you're running the Action on a different repository or organization, create a GitHub API token and store it as a repository secret, referencing it in your workflow.
45
45
46
46
5. Commit and Trigger the Action
47
-
Commit the workflow file to your default branch and wait for the Action to trigger based on your specified schedule or manually initiate it via a [workflow_dispatch](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow).
47
+
Commit the workflow file to your default branch and wait for the Action to trigger based on your specified schedule or manually initiate it via a [workflow_dispatch](https://docs.github.com/en/actions/using-workflows/manually-running-a-workflow).
0 commit comments