Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 3.96 KB

CONTRIBUTING.md

File metadata and controls

103 lines (77 loc) · 3.96 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.

You generally only need to submit a CLA once, so if you've already submitted one (even if it was for a different project), you probably don't need to do it again.

Code reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.

Student contributions

Docsy welcomes contributions from students. However, we cannot guarantee that PRs will be merged within any specific timeframe. We ask that instructors not create assignments requiring students to have PRs merged into the project. We will not merge PRs solely to satisfy any class assignments.

How to contribute

See the contribution guidelines in the Docsy user guide.

Publishing a release

These notes are WIP for creating a release (v0.X.Y) from a local copy of the repo.

  1. Change directory to your local Docsy repo.

  2. Ensure that the CHANGELOG has a release summary entry for v0.X.Y. If not, create one with a brief summary of breaking changes using the section template at the end of the file. (Note that change details are autogenerated by GitHub in a later step.)

  3. Update module and package versions:

    • Update the version of docsy/dependencies in go.mod to v0.X.Y.
    • Update the NPM package version in package.json to 0.X.Y.

  4. Update the Docsy version in userguide/hugo.toml to 0.X.Y.

  5. Commit your changes, usually as a PR entitled "Release v0.X.Y preparation". Once the PR is approved and merged, proceed with the remaining steps.

  6. Ensure that you're:

    • On the default branch
    • At the commit that you want to tag as the next release (usually @HEAD).

  7. Create the tags for v0.X.Y (we currently need two):

    REL=v0.X.Y
git tag $REL
git tag dependencies/$REL

  8. Push the new tags to the main repo (which is named upstream in the following setup):

    $ git push upstream $REL && git push upstream dependencies/$REL
...
* [new tag]         v0.X.Y -> v0.X.Y
* [new tag]         dependencies/v0.X.Y -> dependencies/v0.X.Y

  9. Use the GitHub Draft a new release feature, filling in the fields as follows:

    • From the release/tag dropdown: Select the new release tag that you just pushed, v0.X.Y.

    • Set the release title to the release number (without the "v").

    • Click "auto-generate release notes" to get the release details.

    • Replace the auto-generated "## What's Changed" heading by the following:

      ## Release summary

See, https://github.com/google/docsy/blob/main/CHANGELOG.md#0XY

## Commit details

    • Replace the 0XY anchor target above with a target appropriate for this release.

    • Remove the "New contributors" autogenerated text (if present) since we don't publish that as part of our release notes.

    • Select Create a discussion for this release.

    • Click Publish release.