From 58ef0198e447285a9c60edcbf2e43b9c3d877f79 Mon Sep 17 00:00:00 2001 From: Brooke Hamilton Date: Wed, 3 Mar 2021 09:20:10 -0500 Subject: [PATCH 1/3] contributing.md --- .github/ISSUE_TEMPLATE/question.md | 8 ++++ CONTRIBUTING.md | 66 ++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 000000000..4f855a151 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,8 @@ +--- +name: Question +about: Ask a question or start a discussion +title: '' +labels: question +assignees: '' + +--- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..8ac9064c7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,66 @@ +# Contribution Guidelines + +This project welcomes contributions and suggestions. Most contributions require you to +agree to a Contributor License Agreement (CLA) declaring that you have the right to, +and actually do, grant us the rights to use your contribution. For details, visit +[https://cla.microsoft.com](https://cla.microsoft.com). + +When you submit a pull request, a CLA-bot will automatically determine whether you need +to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the +instructions provided by the bot. You will only need to do this once across all repositories using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) +or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +Contributions come in many forms: submitting issues, writing code, and participating in discussions or questions. + +## Issues + +This section describes the guidelines for submitting issues. + +### Issue Types + +- Question: Ask a question about how the system works, ask for feedback on an idea about how the system could work, or you ran into something unexpected and you want guidance. +- Feature Request: Suggest a new idea for the project. +- Issue: Describe work that the team will do to enhance the product. +- Bug: Report a defect. + +### Before You File + +Before you file an issue, please check the following: + +1. Check for existing issues + - Before you create a new issue, please do a search in [open issues](https://github.com/Azure/missionlz/issues) to see if the issue has already been filed. + - If you find your issue already exists, make comments and add your [reaction](https://github.com/blog/2119-add-reaction-to-pull-requests-issues-and-comments). Use a reaction: + - 👍 up-vote + - 👎 down-vote +1. For bugs + - Have as much data as possible, including any logs or stack traces, environment, and versions. + - Steps to reproduce are essential for understanding how to duplicate the problem. + - Provide clarity on the expected result vs. the actual result. +1. For proposals + - Many changes to the Dapr runtime may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr). + - Other examples could include bindings, state stores or entirely new components. + +### Pull Requests + +All contributions come through pull requests. To submit a proposed change, we recommend following this workflow: + +1. Make sure there's an issue (issue, bug, feature request) raised, which sets the expectations for the contribution you are about to make. +1. Fork the relevant repo and create a new branch +1. Create your change +1. Update relevant documentation for the change +1. Commit and open a PR +1. Wait for the CI process to finish and make sure all checks are green +1. A maintainer of the project will be assigned, and you can expect a review within a few days + +#### Use work-in-progress PRs for early feedback + +A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and assign the **do-not-merge** label. This will let people looking at your PR know that it is not well baked yet. + +### Use of Third-party code + +- Third-party code must include licenses. + +**Thank You!** - Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute. From 4026603212796464741b61705887c7318bb43fc7 Mon Sep 17 00:00:00 2001 From: Brooke Hamilton Date: Wed, 3 Mar 2021 09:26:03 -0500 Subject: [PATCH 2/3] updates to contributing --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ac9064c7..1fd93660b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,9 +39,6 @@ Before you file an issue, please check the following: - Have as much data as possible, including any logs or stack traces, environment, and versions. - Steps to reproduce are essential for understanding how to duplicate the problem. - Provide clarity on the expected result vs. the actual result. -1. For proposals - - Many changes to the Dapr runtime may require changes to the API. In that case, the best place to discuss the potential feature is the main [Dapr repo](https://github.com/dapr/dapr). - - Other examples could include bindings, state stores or entirely new components. ### Pull Requests From f27c6ae81479d46f043fb75b91853ca9ab585c18 Mon Sep 17 00:00:00 2001 From: Brooke Hamilton Date: Wed, 3 Mar 2021 09:38:51 -0500 Subject: [PATCH 3/3] updates to contributing --- CONTRIBUTING.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1fd93660b..4b905c634 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,15 +42,17 @@ Before you file an issue, please check the following: ### Pull Requests -All contributions come through pull requests. To submit a proposed change, we recommend following this workflow: +All contributions come through pull requests (PRs). To submit a proposed change, we recommend following this workflow: 1. Make sure there's an issue (issue, bug, feature request) raised, which sets the expectations for the contribution you are about to make. 1. Fork the relevant repo and create a new branch 1. Create your change -1. Update relevant documentation for the change -1. Commit and open a PR +1. Update documentation where needed +1. Commit the code to your branch +1. Merge any additional changes from main into your branch and resolve any conflicts +1. Create the PR and associate it with the relevent issue 1. Wait for the CI process to finish and make sure all checks are green -1. A maintainer of the project will be assigned, and you can expect a review within a few days +1. A maintainer of the project will be assigned and you can expect a review within a few days #### Use work-in-progress PRs for early feedback