Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 5.69 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 5.69 KB

ITS Propagation Library Wiki Contribution Guide

Thank you for your interest in contributing to this wiki. This document was adapted from GitHub's own, and provides guidelines and helpful links.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. The workflow we recommend and describe here follows from best and common practices in the Git and GitHub ecosystems. We aim to leverage this workflow, especially the elements of code review and approval, to enable open source development of a robust, high quality wiki for the ITS Propagation Library.

Background for new contributors

Here are some resources to help you get started with open source contributions:

Getting Started

Issues

Create a new issue

If you spot a problem with the wiki, search if an issue already exists. If a related issue doesn't exist, we encourage you to open one (even if you don't plan to contribute a resolution yourself). Issues may be opened for content requests, typos, erroneous content, or anything else which you think should be changed.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. You may wish to comment on the issue to let others know if you plan to resolve it with a pull request.

Make Changes

  1. Fork the repository.

  2. Install and set up Quarto by following their guide.

  3. Create a working branch and start with your changes! Use Quarto to preview how the changes will render when the site is deployed.

Commit your update

Commit the changes once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Write a meaningful description of the changes you've made.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged

When your PR is approved and merged, your changes will automatically be deployed to the live wiki site.

Updating USWDS

This repository contains static elements from the U.S. Web Design System, but does not use the recommended installation method with Node and npm. Instead, the static files are included directly from GitHub. To update to a newer release of USWDS, follow these steps:

  1. Check the current version of the USWDS assets included in this repository. The version number is shown in a comment at the top of uswds/css/usdws.css.

  2. Check if a newer version of the USWDS is available here

  3. If a new release is available, review the included changelog to determine if any breaking changes need to be accounted for as part of your update. Most likely, there will not be any, since this site uses relatively few USWDS components. If there are, make the necessary modifications to support the newer version of the USWDS.

  4. Download the new release (.tgz) and extract it. Copy the contents of package/dist/ to this repository's usdws directory. Overwrite all conflicted files. The rest of the files from the downloaded release can be discarded.

  5. Test the site by rendering with Quarto. Ensure that the USWDS components have not broken.

  6. Commit your changes, and open a pull request.