Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 4.73 KB

CONTRIBUTING.md

File metadata and controls

62 lines (33 loc) · 4.73 KB

✨ Contributing to the .NET Aspire Community Toolkit

Thank you for exhibiting interest in contributing to the .NET Aspire Community Toolkit. The team is delighted to welcome you onboard to our exciting and growing project. Any contribution or value added go a long way to enhance the project!

In the next few steps, you will be able to see a glimpse of ways you can contribute to the .NET Aspire Community Toolkit.

❔ Questions

To ensure that the maintainers are able to manage issues, bugs and questions please use the GitHub Issues to report problems with the toolkit, and use GitHub Discussions for general questions.

🐛 Fix a Bug

If you find any bug, you can help the community by submitting an issue. Once the issue is filed, feel free to start working on the PR and submit a PR.

👌 Good First Issue

If this is your first time contributing to the .NET Aspire Community Toolkit and do not have advanced level programming experience, we have got you covered 💥 we have a list of good first issue that can be a great entryway to find and fix any issues that best fit your expertise or technical background.

🙋 Help Wanted

The .NET Aspire Community Toolkit also has a list of issues that are labeled as help wanted. The level of complexity in the list can vary but if you have an advanced level of programming experience, feel free to jump in to solve these issues.

📬 Add New Feature

  • To contribute a new feature, fill out the Feature Request Template and provide detailed information to express the proposal.
  • Once the Feature Request is submitted, it will be open for discussion.
  • If it gets approved by the team, proceed to submit a PR of the proposed Feature.
  • If the PR contains an error-free code and the reviewer signs off, the PR will be merged.

📝 Add or Improve Documentation

The documentation for the .NET Aspire Community Toolkit is available on the Microsoft Docs. If you find any issues with the documentation or want to add more information, you can contribute by submitting a PR to the documentation repository.

🚀 Create, Submit or Review Pull Request

Anyone can create a Pull Request by forking the .NET Aspire Community Toolkit Repository. Here is how you can Create a Pull Request from fork. Once you fork the .NET Aspire Community Toolkit repo, it is essential to create all changes in the feature branch of your forked repository. If you have the changes in the forked feature branch, you can then create a Pull Request in the main .NET Aspire Community Toolkit.

If this is your first time running the solution, be sure to familiarise yourself with how to setup the development environment.

📦 Add New Integration

For more detailed information on how to add a new integration, refer to the building an integration documentation.

Also, familiarise yourself with the versioning and diagnostics documentation to understand the process of adding new integrations and APIs.

🥽 Previewing Packages

Each PR that builds successfully will have a preview package created. You can find the preview package in the Azure Artifacts feed and as artifacts attached to the build.

💙 Thank You

Thank you so much for contributing to this amazing project. We hope you will continue to add value and find yourself as a highly reliable source to the .NET Aspire Community Toolkit.

Code of Conduct

Please see our Code of Conduct.

As should be clear by now: we assume everyone tries to do their best, everyone should be treated with respect and equally.

In the unfortunate event that doesn't happen, please feel free to report it to any of the team members or reach out to Aaron directly.

We will take appropriate actions and measures if necessary.