Skip to content

Added Code of Conduct and Contributing sections to README - #228

Merged
TimidRobot merged 4 commits into
masterfrom
moar-readme-updates
Apr 9, 2020
Merged

Added Code of Conduct and Contributing sections to README#228
TimidRobot merged 4 commits into
masterfrom
moar-readme-updates

Conversation

@TimidRobot

Copy link
Copy Markdown
Member

Description

Added Code of Conduct and Contributing sections to README

(I was inspired by the Authors section of the cccatalog README)

Technical details

Rendered READMEs:

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the master branch of the repository.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • N/A I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

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.

@TimidRobot
TimidRobot requested review from a team, kgodey and mathemancer April 9, 2020 15:51
@TimidRobot TimidRobot self-assigned this Apr 9, 2020

@mathemancer mathemancer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I feel like these sections, or at least Contributing, should be logically grouped with Development, perhaps. I.e., both the Code of conduct, and the development setup seem like subsections under contributing. Out of scope, but as I'm reading it might make sense for 'Project Structure' to be at the top of the README.md.

But, I think it's good to get these in the README.md to start, and quibble about logical grouping if we want to later.

@TimidRobot
TimidRobot merged commit dda6d74 into master Apr 9, 2020
@TimidRobot
TimidRobot deleted the moar-readme-updates branch April 9, 2020 19:31
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.

3 participants