Documenting local debug/test workflows in CONTRIBUTING.md

swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC

https://swiftpackageindex.com/apple/swift-docc-plugin/1.3.0/documentation/swiftdoccplugin

Apache License 2.0

316 stars 54 forks source link

Documenting local debug/test workflows in CONTRIBUTING.md #62

Closed natikgadzhi closed 1 year ago

natikgadzhi commented 1 year ago

Bug/issue #, if applicable: N/A

Summary

This pull-request updates CONTRIBUTING.md:

Changes mentions of Swift JIRA to GitHub, consistent with Swift-DocC repo
Documents how to use local swift-docc-plugin in other Swift packages.
Documents how to use local docc from the plugin.

Related to https://github.com/apple/swift-docc/pull/653 — once @ethan-kusters reviewd that one, I asked if I should clean swift-docc-plugin to be consistent as well.

Dependencies

No code changes, so no dependencies.

natikgadzhi commented 1 year ago

Thank you @ethan-kusters! One change left to manually check — should be ready tomorrow morning Pacific.

ethan-kusters commented 1 year ago

@swift-ci please test

natikgadzhi commented 1 year ago

@ethan-kusters I have a feeling that @swift-ci needs a hug 🥰

ethan-kusters commented 1 year ago

@ethan-kusters I have a feeling that @swift-ci needs a hug 🥰

Indeed! I'm going to go ahead and land this as-is since it's not a code change and I'll debug the CI issue separately. Thank you for your work on this!

natikgadzhi commented 1 year ago

You're very welcome! Sorry I slowed down in the last two weeks. I'll catch up and do some more work over the weekend!