Adding anchors to topic headers

This commit is contained in:
Jason Konicki 2017-10-12 11:58:58 -04:00
Родитель 274c36dd2b
Коммит e3eaf41940
1 изменённых файлов: 14 добавлений и 7 удалений

Просмотреть файл

@ -1,18 +1,25 @@
# How to Contribute
* [Getting Started](#getting-started)
* [Reporting Issues](#reporting-issues)
* [Feature Requests](#feature-requests)
* [Contributing Code](#contributing-code)
* [General Contribution Guidelines](#contribution-guidelines)
* [Governance Model](#governance-model)
One of the easiest ways to contribute is to participate in discussions, provide feedback or simply submit issues when you encounter them.
Of course, we also accept code contributions by submitting pull requests (PR) with code changes.
## Starting Discussions, Providing Feedback or Need Help
## <a name="getting-started"></a>Starting Discussions, Providing Feedback or Need Help
The Steeltoe team hangs out on the [Steeltoe Slack channel](https://steeltoeteam.slack.com), so if you want to start a general discussion, provide feedback or have a question about using Steeltoe, feel free to contact us on Slack. Also, if you have a desire to get involved, but don't know what to do, then reach out to us on Slack. We are glad to help!
The Steeltoe team hangs out on the [Steeltoe Slack channel](https://slack.steeltoe.io), so if you want to start a general discussion, provide feedback or have a question about using Steeltoe, feel free to contact us on Slack. Also, if you have a desire to get involved, but don't know what to do, then reach out to us on Slack. We are glad to help!
Remember, one of the great things about Slack is that you can search the above channels content to see if your idea or question has been discussed already.
By using Slack for questions, discussions and help, that basically leaves the Github issue tracker for use in reporting bugs and feature requests only.
## Reporting Issues
## <a name="reporting-issues"></a>Reporting Issues
If you want to report an issue for a specific Steeltoe package (e.g. Configuration, CircuitBreaker, etc. ) then please open an issue in the appropriate [SteeltoeOSS GitHub repository](https://github.com/SteeltoeOSS).
@ -34,11 +41,11 @@ Before reporting an issue, go through the list below and ask yourself these ques
Make sure before you submit the issue to check the formatting of the content. Remember that GitHub supports [markdown](https://help.github.com/articles/github-flavored-markdown/) formatting in the issue content.
## Feature Requests
## <a name="feature-requests"></a>Feature Requests
The best way to get new feature requests implemented is by contributing code. That said, if you don't feel you have time or the ability to contribute code, then please feel free to start a discussion around your idea or new feature suggestion in the [Steeltoe Slack channel](https://steeltoeteam.slack.com).
## Contributing Code
## <a name="contributing-code"></a>Contributing Code
The Steeltoe team welcomes code contributions from the community and as a part of that we recommend the following guidelines for you to follow to ensure your contributions get proper consideration:
@ -49,7 +56,7 @@ The Steeltoe team welcomes code contributions from the community and as a part o
Please note, when you want to contribute code to a specific Steeltoe package (e.g. Configuration, CircuitBreaker, etc. ) then please follow the above guidelines in the appropriate [SteeltoeOSS GitHub repository](https://github.com/SteeltoeOSS). Specifically, open issues, carry on contribution discussions, and submit PRs, in the repository to which your contribution will be made.
## General Contribution Guidelines
## <a name="contribution-guidelines"></a>General Contribution Guidelines
* Please try to follow our [coding guidelines](https://github.com/SteeltoeOSS/Home/tree/master/project-docs/contributing-coding.md) but give priority to the current style of the project or file you're changing even if it diverges from the general guidelines.
* Please include tests when adding new features. We recommend when fixing bugs, start with adding a test that highlights how the current behavior is broken.
@ -61,7 +68,7 @@ Please note, when you want to contribute code to a specific Steeltoe package (e.
* Please don't add API additions without filing an issue and discussing with us first.
* Please tag any users that should know about and/or review the changes you are wanting to contribute.
## Governance Model
## <a name="governance-model"></a> Governance Model
As a member of the [.NET Foundation](https://dotnetfoundation.org/), the Steeltoe project has adopted a [project governance model](https://github.com/dotnet/home/blob/master/governance/project-governance.md) in line with that recommended by the .NET Foundation.