maxmustermann/pulumi
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add the IDEA category for TODOs

Browse source
This commit is contained in:
joeduffy 2017-06-05 17:51:54 -07:00
parent db99092334
commit 5698735866
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CONTRIBUTING.md
View file

@ -93,10 +93,11 @@ These are some language-agnostic rules we apply across our codebase:
// limitations under the License.
```
* There are two special kinds of comments, each of which MUST have a corresponding work item `xx`:
* There are three special kinds of comments; two MUST have a corresponding work item `xx`, while the other MAY:
- `TODO[pulumi/lumi#xx]: <comment>`: a future suggestion or improvement.
- `BUGBUG[pulumi/lumi#xx]: <comment>`: a knowingly incorrect bit of code -- use sparingly!
- `TODO[pulumi/lumi#xx]: <comment>`: a known loose end for the future: MUST have a work item.
- `BUG[pulumi/lumi#xx]: <comment>`: knowingly incorrect code: use sparingly, MUST have a work item!
- `IDEA[pulumi/lumi(#xx)]: <comment>`: a lesser priority idea for improving the code: MAY have a work item.
* All code SHOULD use defensive coding where applicable, such as liberal assertions and contracts.