Skip to content

Commit 424afe8

Browse files
committed
Update documentation for extensions and contribution model.
1 parent da8edf1 commit 424afe8

File tree

5 files changed

+535
-308
lines changed

5 files changed

+535
-308
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ Welcome and thank you for your interest in contributing to **Virtual Client** pr
44
review this document for policies and procedures which will ease the contribution and review process for everyone.
55
If you have questions, please contact **[email protected]**.
66

7-
### Before Starting
7+
## Before Starting
88
Ensure that you have attended to the preliminaries for the repo and have an understanding of how to build and test your
99
changes to the source code.
1010

1111
* [Repo Fundamentals](README.md)
1212

13-
### Style Guidelines
13+
## Style Guidelines
1414
Most of the coding style is enforced using static code/style analysis toolsets that are integrated into the project when built.
1515
This makes it easier for developers to follow the patterns. The important thing to remember here is that new projects must import
1616
the build environment settings. You can see examples of the import at the bottom of any project (e.g. csproj) file in the
1717
repo.
1818

1919
As a general rule, if it builds, the majority of your style requirements are already completed! :)
2020

21-
### Test Guidelines
21+
## Test Guidelines
2222
Any changes or additions to source code in this repo carry the requirement at a minimum that unit tests be written to verify
2323
important behaviors. The team does not typically accept changes to source code in this repo without having proper unit tests.
2424
Take the time to look at existing unit tests within the project. A lot of effort was made to create unit tests that are clear,
@@ -27,30 +27,23 @@ robust unit tests for code in this repo.
2727

2828
Review our documentation on testing if you would like to learn more on our practices and philosophies around testing.
2929

30-
### Pull Request(PR) Process
30+
## Pull Request(PR) Process
3131
The following steps will help you get your changes in for review by the team. Review the repo README if you need a reminder
3232
or examples on how to build and test code within the repo.
3333

34-
##### Creating/Submitting Changes
35-
* Create a topic branch for your changes (e.g. users/alias/ChangeDescription). We do not allow users to push changes directly to the master branch.
36-
* Ensure all solutions/projects within the repo build successfully before submitting your PR.
34+
### Creating/Submitting Changes
35+
* Create a fork/branch for your changes (e.g. users/alias/ChangeDescription). We do not allow users to push changes directly to the master branch.
36+
* Ensure all solutions/projects within the repo build successfully before submitting your PR (see README noted above).
3737
* Ensure all tests within the repo pass before submitting your PR. Passing unit and functional tests is a gate to complete the PR.
3838
* Update any documentation, user and contributor, that is impacted by your changes.
3939
* Check for markdown (e.g. README.md) files within the solution or project directory.
4040
* Team members will typically help you with pointers to documentation needing update as part of the pull request process.
41-
* Increase the version numbers for any assemblies (.exe or .dll) for which you have changed.
42-
* We use [semantic versioning](http://semver.org/).
43-
* Include your change description in `CHANGELOG.md` file as part of pull request.
4441
* Push your changes to the remote.
45-
* Browse to the Azure DevOps location for the repo and create a pull request for your branch/changes. You do not need to
46-
add reviewers to the pull request. The team will be automatically added. Feel free to add any other reviewers that you'd like
47-
to the pull request though.
48-
* Add a referenced work item to the pull request you created.
42+
* Start a pull request for the team to review.
4943

50-
##### Getting Approvals
44+
### Getting Approvals
5145
After you've created the pull request, the following requirements must be met before you will be able to complete the pull request:
5246
* An automated PR build must complete successfully.
5347
* Team reviewers must review the code and provide at least 1 approval.
5448
* Any feedback/comments provided by reviewers must be resolved and changes committed + pushed to the remote.
55-
* Ownership enforcement must be satisfied. In general this is satisfied by the step above since most (if not all) of the team reviewers
56-
are part of the owners group for the repo (see: owners.txt).
49+
* Once approved, your changes will be merged with the "main" branch.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,19 @@ The following links provide additional information on the Virtual Client project
1414

1515
## [Getting Started](https://microsoft.github.io/VirtualClient/docs/guides/getting-started/)
1616

17-
You will follow the [**Tutorial**](https://microsoft.github.io/VirtualClient/docs/guides/getting-started/) to benchmark your system with a quick workload: OpenSSL Speed - SHA256.
17+
You can follow along with the ["getting started" tutorial](https://microsoft.github.io/VirtualClient/docs/guides/getting-started/) running a quick workload (OpenSSL Speed - SHA256) on your
18+
local system.
1819

1920
## Contributing
2021

21-
We welcome your contribution, and there are many ways to contribute to VirtualClient:
22+
We welcome your contribution, and there are a number of ways to contribute to the Virtual Client project:
2223

23-
* [Just say Hi](https://github.com/microsoft/VirtualClient/discussions/categories/show-and-tell). It inspires us to know that there are fellow performance enthusiatics out there and VirtualClient made your work a little easier.
24-
* [Feature Requests](https://github.com/microsoft/VirtualClient/issues/new/choose). It helps us to know what benchmarks people are using.
25-
* [Submit bugs](https://github.com/microsoft/VirtualClient/issues/new/choose). We apologize for the bug and we will investigate it ASAP.
26-
* Review [source code changes](https://github.com/microsoft/VirtualClient/pulls). You likely know more about one workload than us. Tell us your insights.
27-
* Review the [documentation](https://github.com/microsoft/VirtualClient/tree/main/website/docs) and make pull requests for anything from typos to new content.
28-
* We welcome you to directly work in the codebase. Please take a look at our [CONTRIBUTING.md](./CONTRIBUTING.md). [Start here](https://microsoft.github.io/VirtualClient/docs/category/developing/) and contact us if you have any questions.
24+
* [Make a Feature Request](https://github.com/microsoft/VirtualClient/issues/new/choose).
25+
* [Submit bugs](https://github.com/microsoft/VirtualClient/issues/new/choose). We apologize for anything missed and will investigate it ASAP.
26+
* [Review source code changes](https://github.com/microsoft/VirtualClient/pulls).
27+
* [Review the documentation](https://github.com/microsoft/VirtualClient/tree/main/website/docs).
28+
* [Fork and Contribute Directly](./CONTRIBUTING.md). We welcome you to directly work in the codebase. We offer a [developer guide](https://microsoft.github.io/VirtualClient/docs/category/developing/). Please contact us if you have any questions.
29+
* [Provide Feedback to the Team](https://github.com/microsoft/VirtualClient/discussions/categories/show-and-tell).
2930

3031
Thank you and we look forward to your contribution.
3132

0 commit comments

Comments
 (0)