Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 2.3 KB

Contributing to sample-dotnet-otel

Thank you for your interest in contributing to sample-dotnet-otel! Your contributions play a crucial role in improving the project and advancing its integration with OpenTelemetry in the .NET ecosystem.

Getting Started

  1. Fork the Repository: Click the 'Fork' button at the top right of the main repository page. This will create a copy of the repository in your GitHub account.
  2. Clone the Repository: After forking, clone the repository to your local machine using: 
    git clone https://github.com/YOUR-GITHUB-USERNAME/sample-dotnet-otel.git
  3. Set Up the Project: Follow the instructions in the README to set up the project locally.

Contribution Guidelines

Reporting Bugs

  • Ensure the bug hasn't been reported before by searching through the project's issue tracker.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title, clear description, and as much relevant information as possible.

Suggesting Enhancements

  • Open a new issue in the repository.
  • Clearly describe the enhancement and the motivation for it.
  • Be sure to detail the current behavior and the expected behavior.

Pull Requests

  1. Create a New Branch: For every new feature or fix, create a new branch. 
    git checkout -b feature/your-feature-name
  2. Make Your Changes: Implement your changes, ensuring they adhere to the existing code style.
  3. Commit Your Changes: Commit your changes with a meaningful commit message.
  4. Push to Your Fork: Push your changes to your fork on GitHub. 
    git push origin feature/your-feature-name
  5. Submit a Pull Request: Go to the original sample-dotnet-otel repository and click on "New Pull Request". Choose your fork and the branch you created. Fill out the PR form and submit.

Code Style and Standards

  • Ensure your code adheres to the existing style of the project.
  • Write clear and concise comments explaining your changes.
  • If you introduce new features, ensure they come with appropriate tests and documentation.

Feedback

Your feedback is valuable! If you have any comments, questions, or other feedback, feel free to open an issue in the repository.

Thank you for your contributions and for making sample-dotnet-otel even better!