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
Merged
Changes from 81 commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
92ecee6
new(contrib,doc): org-wide `CONTRIBUTING.md` file
DerekNonGeneric Aug 23, 2022
78dee6c
style: apply changes from prettier-markdown restyler
restyled-commits Aug 23, 2022
c653687
doc: preserve link defintion label case/add links
DerekNonGeneric Aug 25, 2022
9f0bd15
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
9b46655
style: apply changes from whitespace restyler
restyled-commits Aug 25, 2022
e80eb37
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
c9145bc
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
422fb40
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
8cedda6
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
1c5faef
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
764f0a7
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
4223603
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
b838f43
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
8f31ca8
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
a05bbbf
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
e48319e
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
f158647
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
2abf373
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
ba2847e
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
67dfc2f
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
6467c9e
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
5588fc4
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
5cb1079
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
305f6f4
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
60471ab
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
b6312ad
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
ca6f2f4
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
d829800
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
8da9689
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
b208297
Format code with prettier
deepsource-autofix[bot] Aug 25, 2022
059c153
style: apply changes from prettier-markdown restyler
restyled-commits Aug 25, 2022
e667aa9
doc: add note about security issues
DerekNonGeneric Aug 25, 2022
de28da8
doc: use pre-established link to `SECURITY.md`
DerekNonGeneric Aug 25, 2022
5922f4f
Update CONTRIBUTING.md
DerekNonGeneric Nov 13, 2022
8a20dfd
Update CONTRIBUTING.md
DerekNonGeneric Nov 13, 2022
9f16b9d
Update CONTRIBUTING.md
DerekNonGeneric Nov 13, 2022
206dd78
Update CONTRIBUTING.md
DerekNonGeneric Jan 19, 2023
331a21b
style: apply changes from prettier-markdown restyler
restyled-commits Jan 19, 2023
ea643d4
Update CONTRIBUTING.md
DerekNonGeneric Jan 19, 2023
e670aec
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
a9c558a
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
5df211a
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
3a2982e
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
ea71296
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
6c61345
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
9f89ee1
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
8809086
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
ac47702
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
01e8af7
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
4e7d5b1
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
8c924c4
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
5c636c9
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
e6b032e
style: apply changes from prettier-markdown restyler
restyled-commits Jan 21, 2023
289af29
Update CONTRIBUTING.md
DerekNonGeneric Jan 21, 2023
84d2feb
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
a8d8dc0
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
8c44109
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
d66c0b2
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
33e617a
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
881c3c3
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
3d90197
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
3eff8a7
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
eaafc34
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
9e621f4
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
3f81ee5
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
76397a7
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
e2dc2e1
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
3dbeb6e
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
9ade4ef
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
92c03a6
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
31c6e00
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
8befc37
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
76a6156
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
8495800
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
2b73c40
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
6553db0
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
bff95f6
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
56f3796
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
00c3388
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
361970c
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
c1e9bec
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
ae25b10
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
1bc3544
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
103547c
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
bf056dc
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
3452973
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
d42cb19
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
2e83219
Update CONTRIBUTING.md
DerekNonGeneric Jan 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<!--

https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/setting-guidelines-for-repository-contributors

-->

# Contributor Roles and Responsibilities

Want to contribute? Great! First, read this document, which is a set of
guidelines to help you contribute to this project.

Whether you’re finding bugs, adding new capabilities, fixing anything broken, or
improving documentation, get started by submitting an issue or pull request.

This project uses the following tools to organize discussion.

- **Issue tracker:** For discussing issues related to the project.
- **Pull requests:** For discussing and reviewing changes that are in progress.
- **Synchronous chat channel:** For casual conversation, collaboration, quick
exchanges, and questions.

## Issue Tracker

If you’ve found a bug, would like to request a new feature or make a proposal,
file a [GitHub issue][]!

### Resolving Open Issues

We track ongoing endeavors via the GitHub issues associated with each
repository, and that’s where you can find tasks to undertake. First, check the
labels on the issue you’re interested in.

- Issues labeled https://github.com/OpenINF/.github/labels/help%20wanted or
https://github.com/OpenINF/.github/labels/good%20first%20issue have been
identified as desirable for community contribution. Feel free to work on
<abbr title="Good First Issues">GFIs</abbr> even if not your first issue.
- List of [all issues labeled _good first issue_][i-gfi]
- List of [all issues labeled _help wanted_][i-help]
- List of [all incomplete pull requests labeled _help wanted_][pr-help]
- If the issue does not have either of those labels, it may still be open for
contribution.
- Issues labeled https://github.com/OpenINF/.github/labels/wip are a _work in
progress_ and generally not available, but may be available if there has been
no activity on the issue or related PR for over a week.

Once you have identified an issue you would like to work on, follow these steps:

1. Comment on it and say you would like to work on that issue.
2. Wait for someone to confirm that you may work on the issue before writing
any code. The person who confirms will add a
https://github.com/OpenINF/.github/labels/wip label to the issue to indicate
that the issue has been assigned.
3. Once the issue has been labeled as a _work in progress_, write your code and
submit your PR.
4. Wait for code review and address any issues raised as soon as you can.

Even if you are not done with the issue, create a [draft pull request][] and
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
push your code [early and often][]. If we haven’t heard from you in over a week
and someone else expresses interest in that issue, we may approve the new
person’s work.

### Opening a New Issue

If you want to work on something that there is no GitHub issue for, then propose
the change by opening a new GitHub issue associated with the respective
repository and propose your change there. Be sure to include implementation
details and the rationale for the proposed change.

## Pull Requests

If you’d like to propose and collaborate on changes, open a [pull request][]!
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved

Here are a few things you can do that will increase the likelihood of having
your pull request merged:

- Follow standards for style and code quality.
- Write tests when applicable.
- Keep your change as focused as possible. If there are multiple changes you
would like to make that are not dependent upon each other, consider submitting
them as separate pull requests.
- Write a [good commit message][].

Contributions to this project are [released][contrib-license] to the public
under the project’s open source license. The license for a project is located in
a file named `LICENSE` in the root directory of the repository.

## Project Documentation

The [`README.md`][] in the root of the repository should contain or link to
project documentation. If you cannot find the documentation you’re looking for,
please file a GitHub issue with details of what you’d like to see documented.

## Questions or Thoughts?

Support requests (e.g., asking questions) or feedback (e.g., constructive
criticism) may be directed to the [`@OpenINF`][twitter-account] support account
on Twitter.

## Additional Resources

- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
- [GitHub Help](https://help.github.com)

## Code of Conduct

By participating in this project, you are expected to uphold our Code of
Conduct. Please see the [`CODE_OF_CONDUCT.md`][] file for expected behavior.

## 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.


By making a contribution to this project, I certify that:

- (a) The contribution was created in whole or in part by me and I have the
right to submit it under the open source license indicated in the file; or

- (b) The contribution is based upon previous work that, to the best of my
knowledge, is covered under an appropriate open source license and I have the
right under that license to submit that work with modifications, whether
created in whole or in part by me, under the same open source license (unless
I am permitted to submit under a different license), as indicated in the file;
or

- (c) The contribution was provided directly to me by some other person who
certified (a), (b) or (c) and I have not modified it.

- (d) I understand and agree that this project and the contribution are public
and that a record of the contribution (including all personal information I
submit with it, including my sign-off) is maintained indefinitely and may be
redistributed consistent with this project or the open source license(s)
involved.

## Reporting Security Issues

Please see the [`SECURITY.md`][] file.

## Attribution

[Developer Certificate of Origin Legal Text](https://developercertificate.org/)
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
Comment on lines +137 to +139
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/


[**@OpenINF**]: https://github.com/OpenINF
[**@OpenINF/.github**]: https://github.com/OpenINF/.github
[`AUTHORS`]:
https://github.com/OpenINF/.github/blob/HEAD/AUTHORS
'List of people who have contributed code to this project'
[`CODE_OF_CONDUCT.md`]:
./CODE_OF_CONDUCT.md
'Standards for how to engage with the project community'
[`CONTRIBUTING`]: ./CONTRIBUTING.md 'Contribution guidelines for this project'
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
[`funding`]:
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
./.github/FUNDING.yml
'How to financially support maintenance/development of @OpenINF projects on GitHub using GitHub Sponsors'
[`license`]:
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
./LICENSE
'The open source software license(s) associated with this project'
[`readme`]: ./README.md 'The landing/home page of this project'
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
[`security`]:
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
./SECURITY.md
'Instructions on how to report security vulnerabilities for this project'
[`support`]: ./SUPPORT.md 'Where to get help on this project'
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
[`vision`]: ./VISION.md 'What the goal(s) and/or scope are of this project'
DerekNonGeneric marked this conversation as resolved.
Show resolved Hide resolved
[contrib-license]:
https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
[dco]: https://developercertificate.org
[draft pull request]:
https://help.github.com/en/articles/about-pull-requests#draft-pull-requests
[early and often]: https://www.worklytics.co/blog/commit-early-push-often/
[good commit message]:
http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[i-gfi]:
https://github.com/search?q=org%3Aopeninf+is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[i-help]:
https://github.com/search?q=org%3Aopeninf+is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
[twitter-account]: https://twitter.com/OpenINF
[GitHub issue]:
http://help.github.com/en/github/managing-your-work-on-github/creating-an-issue
[pr-help]:
https://github.com/search?q=org%3Aopeninf+is%3Apr+is%3Aopen+label%3A%22help+wanted%22
[pull request]:
https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request