This commit is contained in:
Sima Zhu 2022-01-12 14:02:38 -08:00 коммит произвёл GitHub
Родитель 608fbc37f1
Коммит 80f674ae37
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 10 добавлений и 8 удалений

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

@ -2,39 +2,41 @@
This is the repository used to host tools and libraries used by Azure SDK team engineering system.
We allow to create tools in any language suitable for the tools.
For every newly developing tool, create a new folder with name of brief description of the tool.
For every newly developing tool, create a new folder with brief description on its name.
Do not add third party tools directly in your folder, use it as dependencies.
## Codeowners
Add code owner per tool in [CODEOWNER](https://github.com/Azure/azure-sdk-tools/blob/main/.github/CODEOWNERS) with following format:
Add code owner in [CODEOWNERS](https://github.com/Azure/azure-sdk-tools/blob/main/.github/CODEOWNERS) with following format:
```
/tools/<tool-name>/ @owner1 @owner2
```
## README
Please add README.md file for every tool to illustrate:
1. Add README.md file for every tool to illustrate:
* The purpose of the tool.
* Prerequisites before use
* Prerequisites before use.
* How to use, test and maintain the tool locally and remotely.
* Better to include where the tool is being used.
* Example: [README.md](https://github.com/Azure/azure-sdk-tools/blob/main/tools/http-fault-injector/README.md)
2. Add tool details to the index in root [README.md](https://github.com/Azure/azure-sdk-tools/blob/main/README.md#index).
Example: [README](https://github.com/Azure/azure-sdk-tools/blob/main/tools/http-fault-injector/README.md)
## Testing
Please provide certain test cases to cover important workflow, especially the tool using in azure pipelines or running in prod.
Provide certain test cases to cover important workflow, especially on how it gets used in azure pipelines or running in prod.
Example: [Test library](https://github.com/Azure/azure-sdk-tools/tree/main/tools/pipeline-witness/Azure.Sdk.Tools.PipelineWitness.Tests)
If there is any bundle script, please provide end-to-end test on script as well.
If there is any bundle script, do provide end-to-end test on script as well.
Example: [Custom Test on ci.yml](https://github.com/Azure/azure-sdk-tools/blob/main/tools/code-owners-parser/ci.yml#L35)
## Release ci.yml
- For the tool which is publishing to public repository, please provide ci.yml for building, testing and releasing.
- For the tool which is publishing to public repository, do provide ci.yml for building, testing and releasing.
Example: [ci.yml](https://github.com/Azure/azure-sdk-tools/blob/main/tools/CreateRuleFabricBot/ci.yml)