New location for the contributing docs (#3059)

* combined the contributing docs

* changes to contributing.md

* change menu name

* update docs

Co-authored-by: Itye <ityer@microsoft.com>
This commit is contained in:
Itye Richter 2023-01-05 11:25:50 +02:00 коммит произвёл GitHub
Родитель 913223f63c
Коммит 8512143911
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 35 добавлений и 36 удалений

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

@ -1,24 +1,2 @@
# How to contribute to Azure TRE
First of all thank you. Azure TRE is a collective effort to make it easier to create and manage trusted research environment.
## **Did you find a bug?**
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/microsoft/AzureTRE/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/microsoft/AzureTRE/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
## **Did you write a patch that fixes a bug?**
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* Before submitting, please double check on the current coding conventions used.
## **Do you intend to add a new feature or change an existing one?**
* Open a [new feature issue](https://github.com/microsoft/AzureTRE/issues/new?assignees=&labels=feature&template=feature_request.md&title=) so we can first discuss the changes there. After the discussion you may send a PR with relevant changes. Do not send a PR without discussion on an issue.
## **Do you want to contribute to Azure TRE?**
* Great, please create an issue were the community can discuss the change. Then fork the repository, make your change and then create a PR. Make sure the solution is tested and provide steps on how to test the change in the PR.
Thanks! :heart: :heart: :heart:
# Contributing
Please read the [Contributing](https://microsoft.github.io/AzureTRE/contributing/) guidelines in the documentation site.

31
docs/contributing.md Normal file
Просмотреть файл

@ -0,0 +1,31 @@
# How to contribute to Azure TRE
> To read about how to set up your development environment and contribute to Azure TRE components please visit [Local Development](/using-tre/local-development/local-development/).
## Did you find a bug?
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/microsoft/AzureTRE/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/microsoft/AzureTRE/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBUG%5D). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
## Did you write a patch that fixes a bug?
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* Before submitting, please double check on the current coding conventions used.
## Do you intend to add a new feature or change an existing one?
* Open a [new feature issue](https://github.com/microsoft/AzureTRE/issues/new?assignees=&labels=feature&template=feature_request.md&title=) so we can first discuss the changes there. After the discussion you may send a PR with relevant changes. Do not send a PR without discussion on an issue.
## How to Contribute to our Documentation
* If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
* You can find our existing documentation issues on GitHub by clicking on the link below:
* [Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
* Or, you can raise a new issue by clicking on this link:
* [Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
Thanks! :heart: :heart: :heart:

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

@ -82,16 +82,4 @@ To use a template, and deploy a resource, the template needs to be registered in
If you want to author your own workspace, workspace service, or user resource template, consult the [template authoring guide](../tre-workspace-authors/authoring-workspace-templates.md)
## How to Contribute to our Documentation
If you have any comments or suggestions about our documentation then you can visit our GitHub project and either raise a new issue, or comment on one of the existing ones.
You can find our existing documentation issues on GitHub by clicking on the link below:
[Existing Documentation Issues](https://github.com/microsoft/AzureTRE/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation)
Or, you can raise a new issue by clicking on this link:
[Report an Issue or Make a Suggestion](https://github.com/microsoft/AzureTRE/issues/new/choose)
**Thank you for your patience and support!**

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

@ -158,3 +158,5 @@ nav:
- Checking Logs in Application Insights: troubleshooting-faq/app-insights-logs.md
- Troubleshooting the Resource Processor: troubleshooting-faq/troubleshooting-rp.md
- Manually edit resources in Cosmos DB: troubleshooting-faq/manually-editing-resources.md
- Contributing: contributing.md