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

Add/community files #154

Merged
merged 5 commits into from
Jul 15, 2020
Merged

Add/community files #154

merged 5 commits into from
Jul 15, 2020

Conversation

jeffpaul
Copy link
Member

Description of the Change

This PR adds a Code of Conduct file per #137 as well as CHANGELOG.md and CREDITS.md files to more closely align to 10up's Open Source Best Practices. It also updates the README.md file with references to the newly created files, adds a Table of Contents, and other minor updates.

Alternate Designs

Keep as-is or cherry-pick desired changes specific for this repo.

Benefits

Ensures this project follows repo standards akin to other 10up projects.

Possible Drawbacks

None identified.

Verification Process

Manually verified via GitHub Desktop UI.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

Resolves #137.

Changelog Entry

### Added
- Documentation updates

@jeffpaul jeffpaul added this to the 0.4.3 milestone Jul 15, 2020
@jeffpaul jeffpaul requested a review from ericmann July 15, 2020 01:13
@jeffpaul jeffpaul self-assigned this Jul 15, 2020
@jeffpaul
Copy link
Member Author

@ericmann note that we're also working on renaming the master branch to trunk across 10up repos (see 10up/Open-Source-Best-Practices#62). If you're good with it, I can make those changes and update this PR accordingly?

@coveralls
Copy link

Coverage Status

Coverage remained the same at 52.367% when pulling cd0bfb0 on add/community-files into 9927f0c on master.

@ericmann ericmann merged commit 05ee446 into master Jul 15, 2020
@ericmann ericmann deleted the add/community-files branch July 15, 2020 03:36
@ericmann
Copy link
Collaborator

@jeffpaul Perfectly ok with a change to trunk and I just made that. Feel free to update any other branches to fit the new pattern and I'll jettison the master branch later.

@jeffpaul jeffpaul mentioned this pull request Jul 15, 2020
6 tasks
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.

Should we adopt the Contributor Covenant as a code of conduct for the project?
3 participants