Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.1 KB
Raw

Contributing to Swift Documentation

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Submitting a pull request

Swift Documentation content follows Apple Style Guide and the terms and rules from the TSPL style guide.

By submitting a pull request, you represent that you have the right to license your contribution to the community, and agree by submitting the patch that your contributions are licensed under the Apache 2.0 license (see LICENSE).

Small changes

For small changes, like typo fixes and revisions within a few paragraphs, the discussion of those changes is usually small enough to be part of the pull request.

Larger changes

For large changes, such as new articles, guides, or larger sets of content, please start a thread in the Swift forums to discuss what you are proposing to add. Depending on the size and scope, the project may ask for an outline and/or the intended scope prior to accepting any pull requests for content itself. The work on larger sets of content may also be tracked with issues on this repository in order to coordinate collaboration.

Checking and previewing content changes

Build, check, and preview the documentation using the swift-docc-plugin tooling included with each of the packages.

To check the documentation:

swift package generate-documentation --analyze --warnings-as-errors

To preview a documentation catalog:

swift package --disable-sandbox preview-documentation

How to submit your pull request

Use the following steps when creating a new pull request:

  1. Test that your changes don't have any warnings:
swift package generate-documentation --analyze --warnings-as-errors
  1. Create a pull request in this repository.
  2. Write a brief message in the pull request to introduce your work in context.