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 contributor covenant code of conduct #761

Merged
merged 3 commits into from
Apr 30, 2024

Conversation

salaxander
Copy link
Member

Description

It's good practice to have a code of conduct in the repo (and will be required if Pepr moves to CNCF). Adopting the contributor covenant is a good starting point.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@salaxander
Copy link
Member Author

No idea why CI is grumpy on this one 🙃. Any ideas @cmwylie19?

@schaeferka
Copy link
Collaborator

Is this in addition to the Code of Conduct we have at https://github.com/defenseunicorns/pepr/blob/main/docs/120_contribute/020_code-of-conduct.md?

@cmwylie19
Copy link
Collaborator

No idea why CI is grumpy on this one 🙃. Any ideas @cmwylie19?

deprecation in Node.js v22.0.0 :) , should be good now

@cmwylie19
Copy link
Collaborator

@salaxander do you think we should consolidate our code of conducts? or create a separate one?

@salaxander
Copy link
Member Author

@salaxander do you think we should consolidate our code of conducts? or create a separate one?

So I hadn't noticed the one @schaeferka pointed out. It looks like it's also contributor covenant. We should definitely have one in a markdown file in the repo root. So options would be:

  1. Keep both the new markdown file and the website page
  2. Delete the website page in favor of the new markdown file

Personally, I think it's fine to keep it referenced in both places.

@schaeferka
Copy link
Collaborator

If we want to have it only in one place to keep things easier to maintain, we'll need to take a look at how we have our docs site set up to see if we can modify it so that it pulls the content from the code of conduct in the main repo into the correct section of the docs. I think we do something similar for the docs home page and the main README.md file, but I'll need to take a look at it.

@schaeferka
Copy link
Collaborator

@salaxander Are there any other markdown files that we should have in root? If so, it may make sense to go ahead and add them to the root directory while we're doing the contributor guide.

@salaxander
Copy link
Member Author

@salaxander Are there any other markdown files that we should have in root? If so, it may make sense to go ahead and add them to the root directory while we're doing the contributor guide.

The other one we should probably have is a SUPPORT.md file that highlights when to file an issue vs when to reach out directly etc.

@cmwylie19
Copy link
Collaborator

cmwylie19 commented Apr 29, 2024

Thanks @salaxander @schaeferka , for the sake of this issue, i believe it is now complete. We will discuss in standup if it makes sense to have the docs site pull this code directly into the website.

Issue for SUPPORT.md

cmwylie19
cmwylie19 previously approved these changes Apr 29, 2024
@cmwylie19
Copy link
Collaborator

Hey @salaxander the only problem now is that your commit is not signed. Would you mind signing it?

Signed-off-by: Xander Grzywinski <xandergrzyw@gmail.com>
@cmwylie19 cmwylie19 merged commit 702a14a into defenseunicorns:main Apr 30, 2024
10 checks passed
mjnagel pushed a commit to defenseunicorns/uds-core that referenced this pull request May 20, 2024
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change | Age | Adoption | Passing |
Confidence |
|---|---|---|---|---|---|---|---|
|
[defenseunicorns/uds-common](https://togithub.com/defenseunicorns/uds-common)
| | minor | `v0.3.11` -> `v0.4.2` |
[![age](https://developer.mend.io/api/mc/badges/age/github-tags/defenseunicorns%2fuds-common/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/github-tags/defenseunicorns%2fuds-common/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/github-tags/defenseunicorns%2fuds-common/v0.3.11/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/github-tags/defenseunicorns%2fuds-common/v0.3.11/v0.4.2?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
| [pepr](https://togithub.com/defenseunicorns/pepr) | dependencies |
minor | [`0.29.2` ->
`0.31.0`](https://renovatebot.com/diffs/npm/pepr/0.29.2/0.31.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/pepr/0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/pepr/0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/pepr/0.29.2/0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/pepr/0.29.2/0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
|
[registry1.dso.mil/ironbank/opensource/defenseunicorns/pepr/controller](https://togithub.com/defenseunicorns/pepr)
([source](https://repo1.dso.mil/dsop/opensource/defenseunicorns/pepr/controller))
| | minor | `v0.29.2` -> `v0.31.0` |
[![age](https://developer.mend.io/api/mc/badges/age/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.29.2/v0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/docker/registry1.dso.mil%2fironbank%2fopensource%2fdefenseunicorns%2fpepr%2fcontroller/v0.29.2/v0.31.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>defenseunicorns/uds-common
(defenseunicorns/uds-common)</summary>

###
[`v0.4.2`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.4.2)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.4.1...v0.4.2)

##### Miscellaneous

- give doug a mattermostid attribute and update uds version
([#&#8203;120](https://togithub.com/defenseunicorns/uds-common/issues/120))
([4a85172](https://togithub.com/defenseunicorns/uds-common/commit/4a851720a8ac7e62826efda9e92200ba3a5b6709))

###
[`v0.4.1`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.4.1)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.4.0...v0.4.1)

##### Miscellaneous

- **deps:** update uds common support dependencies
([#&#8203;116](https://togithub.com/defenseunicorns/uds-common/issues/116))
([8aed1e0](https://togithub.com/defenseunicorns/uds-common/commit/8aed1e0ae8b4d65f7418664e8f2c73a16bf42801))

###
[`v0.4.0`](https://togithub.com/defenseunicorns/uds-common/releases/tag/v0.4.0)

[Compare
Source](https://togithub.com/defenseunicorns/uds-common/compare/v0.3.11...v0.4.0)

##### Features

- adds renovate to sh files
([#&#8203;110](https://togithub.com/defenseunicorns/uds-common/issues/110))
([b604d2e](https://togithub.com/defenseunicorns/uds-common/commit/b604d2e1b3fc69f29122f9a709c605f5ecf4da18))

##### Miscellaneous

- add a default to setup to create an admin keycloak user
([#&#8203;111](https://togithub.com/defenseunicorns/uds-common/issues/111))
([7fe0dd4](https://togithub.com/defenseunicorns/uds-common/commit/7fe0dd49a9b7032f9c06a83c5a1c6adbb17e8d63))
- **deps:** update uds common support dependencies
([#&#8203;106](https://togithub.com/defenseunicorns/uds-common/issues/106))
([ab06724](https://togithub.com/defenseunicorns/uds-common/commit/ab067245249e63065d2c266fe3b1a45b155e9de2))
- fix the extract version template for env vars
([#&#8203;115](https://togithub.com/defenseunicorns/uds-common/issues/115))
([72d5d26](https://togithub.com/defenseunicorns/uds-common/commit/72d5d263ce850eac20728eb9330c7b3e26143a2b))

</details>

<details>
<summary>defenseunicorns/pepr (pepr)</summary>

###
[`v0.31.0`](https://togithub.com/defenseunicorns/pepr/releases/tag/v0.31.0)

[Compare
Source](https://togithub.com/defenseunicorns/pepr/compare/v0.30.2...v0.31.0)

#### Feats

- feat: pino log timestamp config by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[defenseunicorns/pepr#801

#### What's Changed

- chore: add `SUPPORT.md` by
[@&#8203;schaeferka](https://togithub.com/schaeferka) in
[defenseunicorns/pepr#785
- chore: add more visibility into watch by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[defenseunicorns/pepr#791
- chore: updates to markdown files to match updated pepr-docs structure
by [@&#8203;schaeferka](https://togithub.com/schaeferka) in
[defenseunicorns/pepr#804
- chore: bump chainguard/node-lts from `1fa615d` to `ad74234` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#805
- chore: bump actions/checkout from 4.1.5 to 4.1.6 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#807
- chore: bump library/node from `487dc5d` to `9e8f45f` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#806
- chore: bump chainguard/node-lts from `a0b51fe` to `db5a181` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#788
- chore: bump [@&#8203;types/node](https://togithub.com/types/node) from
18.19.32 to 18.19.33 in the development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#787
- chore: bump chainguard/node-lts from `db5a181` to `fe26db9` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#793
- chore: bump ossf/scorecard-action from 2.3.1 to 2.3.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#792
- chore: bump kubernetes-fluent-client from 2.4.1 to 2.5.0 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#786
- chore: bump pino from 9.0.0 to 9.1.0 in the production-dependencies
group by [@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#797
- chore: bump kubernetes-fluent-client from 2.5.0 to 2.5.1 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#800
- chore: bump chainguard/node-lts from `fe26db9` to `a8d75b6` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#799
- chore: bump chainguard/node-lts from `a8d75b6` to `1fa615d` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#803

**Full Changelog**:
defenseunicorns/pepr@v0.30.2...v0.31.0

###
[`v0.30.2`](https://togithub.com/defenseunicorns/pepr/releases/tag/v0.30.2)

[Compare
Source](https://togithub.com/defenseunicorns/pepr/compare/v0.30.1...v0.30.2)

#### What's Changed

- chore: bump kubernetes-fluent-client from 2.4.0 to 2.4.1 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#784

**Full Changelog**:
defenseunicorns/pepr@v0.30.1...v0.30.2

###
[`v0.30.1`](https://togithub.com/defenseunicorns/pepr/releases/tag/v0.30.1)

[Compare
Source](https://togithub.com/defenseunicorns/pepr/compare/v0.30.0...v0.30.1)

#### What's Changed

- chore: bump chainguard/node-lts from `564a1aa` to `a0b51fe` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#777
- chore: bump [@&#8203;types/ramda](https://togithub.com/types/ramda)
from 0.29.12 to 0.30.0 in the production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#779
- chore: bump kubernetes-fluent-client from 2.3.2 to 2.4.0 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#781
- chore: bump actions/checkout from 4.1.4 to 4.1.5 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#780
- chore: bump [@&#8203;types/node](https://togithub.com/types/node) from
18.19.31 to 18.19.32 in the development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#782

**Full Changelog**:
defenseunicorns/pepr@v0.30.0...v0.30.1

###
[`v0.30.0`](https://togithub.com/defenseunicorns/pepr/releases/tag/v0.30.0)

[Compare
Source](https://togithub.com/defenseunicorns/pepr/compare/v0.29.2...v0.30.0)

#### Features

- feat: watchcfg is configurable for KFC from Pepr by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[defenseunicorns/pepr#766
[Read more on how to configure
watch](https://docs.pepr.dev/main/user-guide/customization/#customizing-watch-configuration)

#### What's Changed

- chore: sanitize name by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[defenseunicorns/pepr#731
- chore: update build.mjs to get around error by
[@&#8203;cmwylie19](https://togithub.com/cmwylie19) in
[defenseunicorns/pepr#760
- docs: add contributor covenant code of conduct by
[@&#8203;salaxander](https://togithub.com/salaxander) in
[defenseunicorns/pepr#761
- chore: document sdk helpers by
[@&#8203;schaeferka](https://togithub.com/schaeferka) in
[defenseunicorns/pepr#774
- chore: update sdk.md and mutate.md docs by
[@&#8203;schaeferka](https://togithub.com/schaeferka) in
[defenseunicorns/pepr#776
- chore: bump actions/checkout from 4.1.2 to 4.1.3 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#750
- chore: bump [@&#8203;types/eslint](https://togithub.com/types/eslint)
from 8.56.9 to 8.56.10 in the development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#749
- chore: bump chainguard/node-lts from `acc2839` to `8cddb06` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#753
- chore: bump
[@&#8203;commitlint/cli](https://togithub.com/commitlint/cli) from
19.2.2 to 19.3.0 in the development-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#754
- chore: bump chainguard/node-lts from `8cddb06` to `5f09dbf` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#763
- chore: bump actions/checkout from 4.1.3 to 4.1.4 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#756
- chore: bump pino from 8.20.0 to 9.0.0 in the production-dependencies
group by [@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#755
- chore: bump actions/dependency-review-action from 4.2.5 to 4.3.1 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#767
- chore: bump ramda from 0.29.1 to 0.30.0 in the production-dependencies
group by [@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#768
- chore: bump library/node from 20-alpine to 22-alpine by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#769
- chore: bump actions/dependency-review-action from 4.3.1 to 4.3.2 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#771
- chore: bump chainguard/node-lts from `5f09dbf` to `4648bb4` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#770
- chore: bump kubernetes-fluent-client from 2.3.1 to 2.3.2 in the
production-dependencies group by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#772
- chore: bump chainguard/node-lts from `4648bb4` to `564a1aa` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#775
- chore: bump library/node from `9459e24` to `487dc5d` by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[defenseunicorns/pepr#778

#### New Contributors

- [@&#8203;salaxander](https://togithub.com/salaxander) made their first
contribution in
[defenseunicorns/pepr#761

**Full Changelog**:
defenseunicorns/pepr@v0.29.2...v0.30.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/defenseunicorns/uds-core).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMTMuMSIsInVwZGF0ZWRJblZlciI6IjM3LjM2My41IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants