cpp_client_telemetry/CONTRIBUTING.md

3.8 KiB

Contributing

The 1DS C++ SDK community meets every Tuesday at 10:30AM PST. The meeting invitation is published to 1ds.sdk.cpp team calendar:

Meeting agenda and notes are maintained here. If you want to propose topics, please append them to the agenda. To request edit access, please contact 1ds.sdk.cpp@service.microsoft.com or ping us on Teams.

Issues and Feature Requests

Issues and feature requests are tracked on GitHub.

Pull Request

How to Send Pull Requests

Everyone is welcome to contribute code to 1DS C++ SDK via GitHub pull requests (PRs).

To create a new PR, fork the project in GitHub and clone the upstream repo:

$ git clone https://github.com/microsoft/cpp_client_telemetry.git

Add your fork as an origin:

$ git remote add fork https://github.com/YOUR_GITHUB_USERNAME/cpp_client_telemetry.git

Check out a new branch, make modifications and push the branch to your fork:

$ git checkout -b feature_branch_name
# edit files
$ git commit
$ git push fork feature_branch_name

Open a pull request against the main cpp_client_telemetry repo.

How to Receive Comments

  • If the PR is not ready for review, please put [WIP] in the title, tag it as work-in-progress, or mark it as draft.
  • Make sure CLA is signed and CI is clear.

How to Get PR Merged

A PR is considered to be ready to merge when:

  • It has received one approval from Maintainers.
  • Major feedbacks are resolved.
  • It has been open for review for at least one working day. This gives people reasonable time to review.
  • Trivial change (typo, cosmetic, doc, etc.) doesn't have to wait for one day.
  • Urgent fix can take exception as long as it has been actively communicated.

Any Collaborator/Maintainer can merge the PR once it is ready to merge.

Style Guidelines

Coding style guidelines

Please note that we are rapidly evolving product with many different contributors. Some modules have been written following platform-specific coding style. Please try to keep your changes consistent with the coding style of a module you are modifying.

Become a Collaborator

Collaborators have write access to the repo.

To become a Collaborator:

  • Become an active Contributor by working on PRs.
  • Actively participate in the community meeting, design discussion, PR review and issue discussion.
  • Contact the Maintainers, express the willingness and commitment.
  • Acknowledged and approved by two Maintainers.

Become a Maintainer

Maintainers have admin access to the repo.

To become a Maintainer:

  • Become a member of client-telemetry-sdk organization.
  • Become a Collaborator.
  • Demonstrate the ability and commitment.
  • Contact the Maintainers, express the willingness and commitment.
  • Acknowledged and approved by all the current Maintainers.