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

new(contrib,doc): add org-level default CONTRIBUTING.md #22

Merged
merged 88 commits into from
Jan 22, 2023

Conversation

DerekNonGeneric
Copy link
Member

@DerekNonGeneric DerekNonGeneric commented Aug 23, 2022

I am opening this as a draft PR to ensure that the part about commits signing, commit message format, and PR title is covered here as well once we get guidelines for that drafted (conventional commits, slightly customized).

Signed-off-by: Derek Lewis [email protected]

/cc @yuvilio @shellscape

@DerekNonGeneric DerekNonGeneric added documentation Improvements or additions to documentation help wanted Extra attention is needed wip Issues and PRs that are still a work in progress labels Aug 23, 2022
@DerekNonGeneric DerekNonGeneric marked this pull request as draft August 23, 2022 14:00
CONTRIBUTING.md Outdated Show resolved Hide resolved
@DerekNonGeneric DerekNonGeneric marked this pull request as ready for review August 25, 2022 07:22
CONTRIBUTING.md Outdated Show resolved Hide resolved
Comment on lines +133 to +135
## Attribution

[Developer Certificate of Origin Legal Text](https://developercertificate.org/)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Attribution
[Developer Certificate of Origin Legal Text](https://developercertificate.org/)

I do not think this should be an h2-level heading as it is here and should instead use the
GitHub-flavored Markdown for footnotes as attribution1 if possible…

Footnotes

  1. https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/

By participating in this project, you are expected to uphold our [Code of
Conduct][code_of_conduct].

## Developer’s Certificate of Origin 1.1
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This touches on a key point related to "commit message validation" not yet covered by https://github.com/openinf/openinf.github.io/issues/32, namely the Signed-off-by: trailer.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@DerekNonGeneric DerekNonGeneric added the depends-on Issues and PRs that depend on other workstreams being completed first label Aug 25, 2022
DerekNonGeneric added a commit to OpenINF/openinf.github.io that referenced this pull request Oct 21, 2022
@DerekNonGeneric
Copy link
Member Author

Maybe this should be distinct from DEVELOPMENT.md? See what happened to me in OpenINF/openinf.github.io#611, but this should probably cover things like commit conventions/code style guidelines (or at least mention/link to where this info can be found)…

I liked the pnpm contributing guide at first glance.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@DerekNonGeneric DerekNonGeneric changed the title new(contrib,doc): org-wide CONTRIBUTING.md file new(contrib,doc): org-level default CONTRIBUTING.md file Jan 19, 2023
@DerekNonGeneric DerekNonGeneric changed the title new(contrib,doc): org-level default CONTRIBUTING.md file new(contrib,doc): add org-level default CONTRIBUTING.md Jan 19, 2023
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@DerekNonGeneric
Copy link
Member Author

You're all set. A job has been queued to uninstall Restyled.io

CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
CONTRIBUTING.md Outdated Show resolved Hide resolved
Signed-off-by: Derek Lewis <[email protected]>
@DerekNonGeneric DerekNonGeneric removed help wanted Extra attention is needed depends-on Issues and PRs that depend on other workstreams being completed first labels Jan 22, 2023
@DerekNonGeneric
Copy link
Member Author

Does not depend on #104

@DerekNonGeneric DerekNonGeneric merged commit 9c1903a into main Jan 22, 2023
@DerekNonGeneric DerekNonGeneric deleted the doc/create-contrib-file branch January 22, 2023 07:13
@DerekNonGeneric DerekNonGeneric added markdown An issue or PR related to Markdown and removed wip Issues and PRs that are still a work in progress labels Jan 22, 2023
DerekNonGeneric added a commit that referenced this pull request Feb 22, 2023
* new(contrib,doc): org-wide `CONTRIBUTING.md` file

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* doc: preserve link defintion label case/add links

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* style: apply changes from whitespace restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Format code with prettier

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* doc: add note about security issues

Signed-off-by: Derek Lewis <[email protected]>

* doc: use pre-established link to `SECURITY.md`

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* style: apply changes from prettier-markdown restyler

Signed-off-by: Restyled.io <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

* Update CONTRIBUTING.md

Signed-off-by: Derek Lewis <[email protected]>

Signed-off-by: Derek Lewis <[email protected]>
Signed-off-by: Restyled.io <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation markdown An issue or PR related to Markdown
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants