|
1 | | -# Contributing to [project-title] |
2 | | - |
3 | | -This project welcomes contributions and suggestions. Most contributions require you to agree to a |
4 | | -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
5 | | -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. |
6 | | - |
7 | | -When you submit a pull request, a CLA bot will automatically determine whether you need to provide |
8 | | -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions |
9 | | -provided by the bot. You will only need to do this once across all repos using our CLA. |
10 | | - |
11 | | -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
12 | | -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
13 | | -contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
14 | | - |
15 | | - - [Code of Conduct](#coc) |
16 | | - - [Issues and Bugs](#issue) |
17 | | - - [Feature Requests](#feature) |
18 | | - - [Submission Guidelines](#submit) |
19 | | - |
20 | | -## <a name="coc"></a> Code of Conduct |
21 | | -Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
22 | | - |
23 | | -## <a name="issue"></a> Found an Issue? |
24 | | -If you find a bug in the source code or a mistake in the documentation, you can help us by |
25 | | -[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can |
26 | | -[submit a Pull Request](#submit-pr) with a fix. |
27 | | - |
28 | | -## <a name="feature"></a> Want a Feature? |
29 | | -You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub |
30 | | -Repository. If you would like to *implement* a new feature, please submit an issue with |
31 | | -a proposal for your work first, to be sure that we can use it. |
32 | | - |
33 | | -* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr). |
34 | | - |
35 | | -## <a name="submit"></a> Submission Guidelines |
36 | | - |
37 | | -### <a name="submit-issue"></a> Submitting an Issue |
38 | | -Before you submit an issue, search the archive, maybe your question was already answered. |
39 | | - |
40 | | -If your issue appears to be a bug, and hasn't been reported, open a new issue. |
41 | | -Help us to maximize the effort we can spend fixing issues and adding new |
42 | | -features, by not reporting duplicate issues. Providing the following information will increase the |
43 | | -chances of your issue being dealt with quickly: |
44 | | - |
45 | | -* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps |
46 | | -* **Version** - what version is affected (e.g. 0.1.2) |
47 | | -* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you |
48 | | -* **Browsers and Operating System** - is this a problem with all browsers? |
49 | | -* **Reproduce the Error** - provide a live example or a unambiguous set of steps |
50 | | -* **Related Issues** - has a similar issue been reported before? |
51 | | -* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be |
52 | | - causing the problem (line of code or commit) |
53 | | - |
54 | | -You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new]. |
55 | | - |
56 | | -### <a name="submit-pr"></a> Submitting a Pull Request (PR) |
57 | | -Before you submit your Pull Request (PR) consider the following guidelines: |
58 | | - |
59 | | -* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR |
60 | | - that relates to your submission. You don't want to duplicate effort. |
61 | | - |
62 | | -* Make your changes in a new git fork: |
63 | | - |
64 | | -* Commit your changes using a descriptive commit message |
65 | | -* Push your fork to GitHub: |
66 | | -* In GitHub, create a pull request |
67 | | -* If we suggest changes then: |
68 | | - * Make the required updates. |
69 | | - * Rebase your fork and force push to your GitHub repository (this will update your Pull Request): |
70 | | - |
71 | | - ```shell |
72 | | - git rebase master -i |
73 | | - git push -f |
74 | | - ``` |
75 | | - |
76 | | -That's it! Thank you for your contribution! |
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +The Azure Service Operator project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted. |
| 4 | + |
| 5 | +Please see also the [Azure Service Operator Developer Guide](docs/community/developer-guide.md). |
| 6 | + |
| 7 | +## Contributor License Agreements |
| 8 | + |
| 9 | +We'd love to accept your patches! Before we can take them, we have to jump a |
| 10 | +couple of legal hurdles. |
| 11 | + |
| 12 | +The [Microsoft CLA](https://cla.microsoft.com/) must be signed by all contributors. Please fill out either the individual or corporate Contributor License Agreement (CLA). Once you are CLA'ed, we'll be able to accept your pull requests. |
| 13 | + |
| 14 | +***NOTE***: Only original source code from you and other people that have |
| 15 | +signed the CLA can be accepted into the repository. |
| 16 | + |
| 17 | +## Support Channels |
| 18 | + |
| 19 | +This is an open source project and as such no formal support is available. However, like all good open source projects we do offer "best effort" support through github issues. |
| 20 | + |
| 21 | +GitHub issues can be filed here - https://github.com/Azure/azure-service-operator/issues |
| 22 | + |
| 23 | +Before opening a new issue or submitting a new pull request, it's helpful to search the project - it's likely that another user has already reported the issue you're facing, or it's a known issue that we're already aware of. |
| 24 | + |
| 25 | +## Issues |
| 26 | + |
| 27 | +Issues are used as the primary method for tracking anything to do with the Azure Service Operator project. |
| 28 | + |
| 29 | +### Issue Lifecycle |
| 30 | + |
| 31 | +The issue lifecycle is mainly driven by the core maintainers, but is good information for those contributing to the project. All issue types follow the same general lifecycle. Differences are noted below. |
| 32 | +1. Issue creation |
| 33 | +2. Triage |
| 34 | + - The maintainer in charge of triaging will apply the proper labels for the issue. This includes labels for priority, type, and metadata. If additional |
| 35 | + labels are needed in the future, we will add them. |
| 36 | + - (If needed) Clean up the title to succinctly and clearly state the issue. Also ensure that proposals are prefaced with "Proposal". |
| 37 | +3. Discussion |
| 38 | + - "Feature" and "Bug" issues should be connected to the PR that resolves it. |
| 39 | + - Whoever is working on a "Feature" or "Bug" issue (whether a maintainer or someone from the community), should either assign the issue to themself or make a comment in the issue saying that they are taking it. |
| 40 | + - "Proposal" and "Question" issues should stay open until resolved or if they have not been active for more than 30 days. This will help keep the issue queue to a manageable size and reduce noise. Should the issue need to stay open, the `keep open` label can be added. |
| 41 | +4. Issue closure |
| 42 | + |
| 43 | +## How to Contribute a Patch |
| 44 | + |
| 45 | +1. If you haven't already done so, sign a Contributor License Agreement (see details above). |
| 46 | +2. Fork the desired repo, develop and test your code changes. |
| 47 | +3. Submit a pull request. |
| 48 | + |
| 49 | +## Reporting Security Issues |
| 50 | + |
| 51 | +Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, including this one. |
| 52 | + |
| 53 | +If you believe you have found a security vulnerability in this repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. |
| 54 | + |
| 55 | +**Please do not report security vulnerabilities through public GitHub issues.** |
| 56 | + |
| 57 | +Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). |
| 58 | + |
| 59 | +We prefer all communications to be in English. |
| 60 | + |
| 61 | +Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). |
0 commit comments