Skip to content
This repository was archived by the owner on Jan 11, 2023. It is now read-only.

Commit 80bdfb2

Browse files
seanknoxdmitsh
authored and
dmitsh
committed
PROPOSAL: version numbering scheme using SemVer 2.0 (#642)
* Initial definition of contributing guidelines, milestones * (docs) Simplify milestones, better define support and issue triage * (docs)add core maintainers list
1 parent 2ab6e89 commit 80bdfb2

File tree

3 files changed

+69
-12
lines changed

3 files changed

+69
-12
lines changed

CONTRIBUTING.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributing Guidelines
2+
3+
The Microsoft acs-engine project accepts contributions via GitHub pull requests. This document outlines the process to help get your contribution accepted.
4+
5+
## Contributor License Agreements
6+
7+
We'd love to accept your patches! Before we can take them, we have to jump a
8+
couple of legal hurdles.
9+
10+
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. Once you are CLA'ed, we'll be able to accept your pull requests.
11+
12+
***NOTE***: Only original source code from you and other people that have
13+
signed the CLA can be accepted into the repository.
14+
15+
16+
## Support Channels
17+
18+
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.
19+
20+
GitHub issues:
21+
- ACS-Engine: https://github.com/Azure/acs-engine/issues - file issues and PRs related to ACS-Engine
22+
- ACS: https://github.com/Azure/acs/issues - file issues and PRs related to Azure Container Service
23+
24+
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.
25+
26+
## Milestones
27+
We use milestones to track progress of releases.
28+
29+
For example, if the current version is `2.2.0` an issue/PR could fall in to one of 2 different active milestones:
30+
`2.2.1`, `2.3.0`. If an issue pertains to a
31+
specific upcoming bug or minor release, it would go into `2.2.1` or `2.3.0`.
32+
33+
A milestone (and hence release) is considered done when all outstanding issues/PRs have been closed or moved to another milestone.
34+
35+
## Issues
36+
Issues are used as the primary method for tracking anything to do with the acs-engine project.
37+
38+
### Issue Lifecycle
39+
The issue lifecycle is mainly driven by the core maintainers, but is good information for those
40+
contributing to acs-engine. All issue types follow the same general lifecycle. Differences are noted below.
41+
1. Issue creation
42+
2. Triage
43+
- The maintainer in charge of triaging will apply the proper labels for the issue. This
44+
includes labels for priority, type, and metadata (such as "orchestrator/k8s"). If additional
45+
levels are needed in the future, we will add them.
46+
- (If needed) Clean up the title to succinctly and clearly state the issue. Also ensure
47+
that proposals are prefaced with "Proposal".
48+
- Add the issue to the correct milestone. If any questions come up, don't worry about
49+
adding the issue to a milestone until the questions are answered.
50+
- We attempt to do this process at least once per work day.
51+
3. Discussion
52+
- "Feature" and "Bug" issues should be connected to the PR that resolves it.
53+
- Whoever is working on a "Feature" or "Bug" issue (whether a maintainer or someone from
54+
the community), should either assign the issue to them self or make a comment in the issue
55+
saying that they are taking it.
56+
- "Proposal" and "Question" issues should stay open until resolved or if they have not been
57+
active for more than 30 days. This will help keep the issue queue to a manageable size and
58+
reduce noise. Should the issue need to stay open, the `keep open` label can be added.
59+
4. Issue closure
60+
61+
## How to Contribute a Patch
62+
63+
1. If you haven't already done so, sign a Contributor License Agreement (see details above).
64+
2. Fork the desired repo, develop and test your code changes.
65+
3. Submit a pull request.

OWNERS

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
maintainers:
2+
- anhowe
3+
- colemickens
4+
- seanknox

docs/contributing.md

-12
This file was deleted.

0 commit comments

Comments
 (0)