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: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,11 +19,11 @@ All types of contributions are encouraged and valued. See the [Table of Contents
19
19
20
20
## I Have a Question
21
21
22
-
Before you ask a question, it is best to search for existing [Issues](https://github.com/github/contributors/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
22
+
Before you ask a question, it is best to search for existing [Issues](https://github.com/github-community-projects/contributors/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
23
23
24
24
If you then still feel the need to ask a question and need clarification, we recommend the following:
25
25
26
-
- Open an [Issue](https://github.com/github/contributors/issues/new).
26
+
- Open an [Issue](https://github.com/github-community-projects/contributors/issues/new).
27
27
- Provide as much context as you can about what you're running into.
28
28
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
29
29
@@ -45,7 +45,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
45
45
46
46
- Make sure that you are using the latest version.
47
47
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the documentation. If you are looking for support, you might want to check [this section](#i-have-a-question)).
48
-
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/github/contributors/issues).
48
+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/github-community-projects/contributors/issues).
49
49
- Collect information about the bug:
50
50
- Stack trace (Traceback)
51
51
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
@@ -57,7 +57,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
57
57
58
58
### How Do I Submit a Good Bug Report?
59
59
60
-
Please submit a bug report using our [GitHub Issues template](https://github.com/github/contributors/issues/new?template=bug_report.yml).
60
+
Please submit a bug report using our [GitHub Issues template](https://github.com/github-community-projects/contributors/issues/new?template=bug_report.yml).
61
61
62
62
## Suggesting Enhancements
63
63
@@ -69,14 +69,14 @@ This section guides you through submitting an enhancement suggestion for contrib
69
69
70
70
- Make sure that you are using the latest version.
71
71
- Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
72
-
- Perform a [search](https://github.com/github/contributors/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
72
+
- Perform a [search](https://github.com/github-community-projects/contributors/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
73
73
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature or to develop the feature yourself and contribute it to the project.
74
74
75
75
<!-- omit in toc -->
76
76
77
77
### How Do I Submit a Good Enhancement Suggestion?
78
78
79
-
Please submit an enhancement suggestion using our [GitHub Issues template](https://github.com/github/contributors/issues/new?template=feature_request.yml).
79
+
Please submit an enhancement suggestion using our [GitHub Issues template](https://github.com/github-community-projects/contributors/issues/new?template=feature_request.yml).
80
80
81
81
### Pull Request Standards
82
82
@@ -86,4 +86,4 @@ We are using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.
86
86
87
87
Releases are automated if a pull request is labelled with our [SemVer related labels](.github/release-drafter.yml) or with the `vuln` or `release` labels.
88
88
89
-
You can also manually initiate a release you can do so through the GitHub Actions UI. If you have permissions to do so, you can navigate to the [Actions tab](https://github.com/github/contributors/actions/workflows/release.yml) and select the `Run workflow` button. This will allow you to select the branch to release from and the version to release.
89
+
You can also manually initiate a release you can do so through the GitHub Actions UI. If you have permissions to do so, you can navigate to the [Actions tab](https://github.com/github-community-projects/contributors/actions/workflows/release.yml) and select the `Run workflow` button. This will allow you to select the branch to release from and the version to release.
org.opencontainers.image.description="GitHub Action that given an organization or repository, produces information about the contributors over the specified time period."
This is a GitHub Action that given an organization or specified repositories, produces information about the [contributors](https://chaoss.community/kb/metric-contributors/) over the specified time period.
9
9
@@ -20,7 +20,7 @@ This action was developed by the GitHub OSPO for our own use and developed in a
20
20
21
21
## Support
22
22
23
-
If you need support using this project or have questions about it, please [open up an issue in this repository](https://github.com/github/contributors/issues). Requests made directly to GitHub staff or support team will be redirected here to open an issue. GitHub SLA's and support/services contracts do not apply to this repository.
23
+
If you need support using this project or have questions about it, please [open up an issue in this repository](https://github.com/github-community-projects/contributors/issues). Requests made directly to GitHub staff or support team will be redirected here to open an issue. GitHub SLA's and support/services contracts do not apply to this repository.
24
24
25
25
### OSPO GitHub Actions as a Whole
26
26
@@ -85,16 +85,16 @@ This action can be configured to authenticate with GitHub App Installation or Pe
|`GH_ENTERPRISE_URL`| False | "" | The `GH_ENTERPRISE_URL` is used to connect to an enterprise server instance of GitHub. github.com users should not enter anything here. |
91
-
|`ORGANIZATION`| Required to have `ORGANIZATION` or `REPOSITORY`|| The name of the GitHub organization which you want the contributor information of all repos from. ie. github.com/github would be `github`|
92
-
|`REPOSITORY`| Required to have `ORGANIZATION` or `REPOSITORY`|| The name of the repository and organization which you want the contributor information from. ie. `github/contributors` or a comma separated list of multiple repositories `github/contributor,super-linter/super-linter`|
93
-
|`START_DATE`| False | Beginning of time | The date from which you want to start gathering contributor information. ie. Aug 1st, 2023 would be `2023-08-01`. |
94
-
|`END_DATE`| False | Current Date | The date at which you want to stop gathering contributor information. Must be later than the `START_DATE`. ie. Aug 2nd, 2023 would be `2023-08-02`|
95
-
|`SPONSOR_INFO`| False | False | If you want to include sponsor information in the output. This will include the sponsor count and the sponsor URL. This will impact action performance. ie. SPONSOR_INFO = "False" or SPONSOR_INFO = "True" |
96
-
|`LINK_TO_PROFILE`| False | True | If you want to link usernames to their GitHub profiles in the output. ie. LINK_TO_PROFILE = "True" or LINK_TO_PROFILE = "False" |
97
-
|`OUTPUT_FILENAME`| False | contributors.md | The output filename for the markdown report. ie. OUTPUT_FILENAME = "my-report.md" |
|`GH_ENTERPRISE_URL`| False | "" | The `GH_ENTERPRISE_URL` is used to connect to an enterprise server instance of GitHub. github.com users should not enter anything here. |
91
+
|`ORGANIZATION`| Required to have `ORGANIZATION` or `REPOSITORY`|| The name of the GitHub organization which you want the contributor information of all repos from. ie. github.com/github would be `github`|
92
+
|`REPOSITORY`| Required to have `ORGANIZATION` or `REPOSITORY`|| The name of the repository and organization which you want the contributor information from. ie. `github-community-projects/contributors` or a comma separated list of multiple repositories `github/contributor,super-linter/super-linter`|
93
+
|`START_DATE`| False | Beginning of time | The date from which you want to start gathering contributor information. ie. Aug 1st, 2023 would be `2023-08-01`. |
94
+
|`END_DATE`| False | Current Date | The date at which you want to stop gathering contributor information. Must be later than the `START_DATE`. ie. Aug 2nd, 2023 would be `2023-08-02`|
95
+
|`SPONSOR_INFO`| False | False | If you want to include sponsor information in the output. This will include the sponsor count and the sponsor URL. This will impact action performance. ie. SPONSOR_INFO = "False" or SPONSOR_INFO = "True" |
96
+
|`LINK_TO_PROFILE`| False | True | If you want to link usernames to their GitHub profiles in the output. ie. LINK_TO_PROFILE = "True" or LINK_TO_PROFILE = "False" |
97
+
|`OUTPUT_FILENAME`| False | contributors.md | The output filename for the markdown report. ie. OUTPUT_FILENAME = "my-report.md" |
98
98
99
99
**Note**: If `start_date` and `end_date` are specified then the action will determine if the contributor is new. A new contributor is one that has contributed in the date range specified but not before the start date.
0 commit comments