Skip to content

Commit

Permalink
docs: Added Contribution Guideline.
Browse files Browse the repository at this point in the history
  • Loading branch information
hennadiilu authored Mar 24, 2024
1 parent 7a4dd07 commit 005fcb9
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,22 @@ Hrefs to such files can be specified as `internal-store-folder/your-file.xsd`.

`hx.xmldoc.toc / action` - one of the [TreeItemActionType](https://github.com/dotnet/docfx/blob/main/src/Docfx.Plugins/TreeItemActionType.cs)

`hx.xmldoc.toc / key` - a TOC item key to apply the action. If the key starts with `~`, then it is used as Href, otherwise as Uid.
`hx.xmldoc.toc / key` - a TOC item key to apply the action. If the key starts with `~`, then it is used as Href, otherwise as Uid.

## Contribution Guideline

1. [Create a fork](https://github.com/Heleonix/Heleonix.Docfx.Plugins.XmlDoc/fork) from the main repository
2. Implement whatever is needed
3. [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
Make sure the assigned [Checks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks#checks) pass successfully.
You can watch the progress in the [PR: .NET](https://github.com/Heleonix/Heleonix.Docfx.Plugins.XmlDoc/actions/workflows/pr-net.yml) GitHub workflows
4. [Request review](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review) from the code owner
5. Once approved, merge your Pull Request via [Squash and merge](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits)

> [!IMPORTANT]
> While merging, enter a [Conventional Commits](https://www.conventionalcommits.org/) commit message.
> This commit message will be used in automatically generated [Github Release Notes](https://github.com/Heleonix/Heleonix.Docfx.Plugins.XmlDoc/releases)
> and [NuGet Release Notes](https://www.nuget.org/packages/Heleonix.Docfx.Plugins.XmlDoc/#releasenotes-body-tab)
6. Monitor the [Release: .NET / NuGet](https://github.com/Heleonix/Heleonix.Docfx.Plugins.XmlDoc/actions/workflows/release-net-nuget.yml) GitHub workflow to make sure your changes are delivered successfully
7. In case of any issues, please contact [[email protected]](mailto:[email protected])

0 comments on commit 005fcb9

Please sign in to comment.