Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add CONTRIBUTING.md at root of repo, directing to docs/ #3121

Merged

Conversation

jmeridth
Copy link
Member

@jmeridth jmeridth commented Oct 23, 2023

Add a root CONTRIBUTING.md that directs to docs/CONTRIBUTING.md

Details

  • having a CONTRIBUTING.md at the root of the repo is a common convention
    • I looked at the root of the repo initially, didn't find it, then checked the website, but potential contributors may think it doesn't exist as a result

Shamelessly copied from argoproj/argo-workflows#10969 (thank you @agilgur5)

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
  • The title of the PR is (a) conventional with a list of types and scopes found here, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
  • I've signed my commits with DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My builds are green. Try syncing with master if they are not.
  • My organization is added to USERS.md.

Add a root CONTRIBUTING.md that directs to docs/CONTRIBUTING.md

# Details

- having a `CONTRIBUTING.md` at the root of the repo is a common convention
  - I looked at the root of the repo initially, didn't find it, then checked the website, but potential contributors may think it doesn't exist as a result

Shamelessly copied from argoproj/argo-workflows#10969 (thank you @agilgur5)

Signed-off-by: jmeridth <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Oct 23, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@jmeridth jmeridth self-assigned this Oct 23, 2023
@github-actions
Copy link
Contributor

Go Published Test Results

2 062 tests   2 062 ✔️  2m 42s ⏱️
   118 suites         0 💤
       1 files           0

Results for commit 09fe06a.

@github-actions
Copy link
Contributor

E2E Tests Published Test Results

    4 files      4 suites   3h 31m 33s ⏱️
102 tests   90 ✔️   6 💤   6
432 runs  386 ✔️ 24 💤 22

For more details on these failures, see this check.

Results for commit 09fe06a.

@zachaller zachaller merged commit 9ecdeed into argoproj:master Oct 23, 2023
22 checks passed
@jmeridth jmeridth deleted the jm-add-contributing-to-repo-root branch October 23, 2023 12:12
zachaller added a commit that referenced this pull request Oct 23, 2023
balasoiuroxana pushed a commit to balasoiuroxana/argo-rollouts that referenced this pull request Oct 27, 2023
…oj#3121)

Add a root CONTRIBUTING.md that directs to docs/CONTRIBUTING.md

# Details

- having a `CONTRIBUTING.md` at the root of the repo is a common convention
  - I looked at the root of the repo initially, didn't find it, then checked the website, but potential contributors may think it doesn't exist as a result

Shamelessly copied from argoproj/argo-workflows#10969 (thank you @agilgur5)

Signed-off-by: jmeridth <[email protected]>
Signed-off-by: balasoiu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants