Skip to content

Commit f46409f

Browse files
author
Danny McCormick
authored
Updating documentation (microsoft#461)
* Updating documentation * Fixing broken link * Cutting out irrelevant parts of contributing * Added issue template * Update numbering * Just got rid of issue logging section of contributing, kinda redundant with issue template * Just got rid of issue logging section of contributing, kinda redundant with issue template * Just got rid of issue logging section of contributing, kinda redundant with issue template
1 parent 3ca1b0e commit f46409f

File tree

3 files changed

+71
-1
lines changed

3 files changed

+71
-1
lines changed

CONTRIBUTING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Instructions for Contributing Code
2+
3+
## Contributing bug fixes
4+
5+
We are currently accepting contributions in the form of bug fixes. A bug must have an issue tracking it in the issue tracker. Your pull request should include a link to the bug that you are fixing. If you've submitted a PR for a bug, please post a comment in the bug to avoid duplication of effort.
6+
7+
## Contributing features
8+
9+
Features (things that add new or improved functionality) may be accepted, but will need to first be approved in the form of a suggestion issue.
10+
11+
Design changes will not be accepted at this time. If you have a design change proposal, please log a suggestion issue.
12+
13+
## Legal
14+
15+
You will need to complete a Contributor License Agreement (CLA). Briefly, this agreement testifies that you are granting us permission to use the submitted change according to the terms of the project's license, and that the work being submitted is under appropriate copyright.
16+
17+
Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally.
18+
19+
## Housekeeping
20+
21+
Your pull request should:
22+
23+
* Include a description of what your change intends to do
24+
* Be a child commit of a reasonably recent commit in the **master** branch
25+
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
26+
* It is desirable, but not necessary, for the tests to pass at each commit
27+
* Have clear commit messages
28+
* e.g. "Refactor feature", "Fix issue", "Add tests for issue"
29+
* Include adequate tests
30+
* At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why
31+
* Tests should include reasonable permutations of the target fix/change
32+
* Include baseline changes with your change
33+
* All changed code must have 100% code coverage

ISSUE_TEMPLATE.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Please check our current Issues to see if someone already reported this https://github.com/Microsoft/azure-pipelines-task-lib/issues
2+
3+
### Environment
4+
azure-pipelines-task-lib version:
5+
6+
### Issue Description
7+
<!--- Please provide a short description of the issue -->
8+
9+
### Expected behaviour
10+
<!--- Tell us what should happen -->
11+
12+
### Actual behaviour
13+
<!--- Tell us what happens instead -->
14+
15+
### Steps to reproduce
16+
1.
17+
2.
18+
3.
19+
4.
20+
5.
21+
22+
### Logs
23+
<!-- Any logs you have/stack traces/etc. -->

node/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,13 @@ The [ShellScript Task](https://github.com/Microsoft/azure-pipelines-tasks/tree/m
2323

2424
## Contributing
2525

26-
### Node
26+
We are accepting contributions and we try to stay on top of issues.
27+
28+
[Contribution Guide](../CONTRIBUTING.md).
29+
30+
[Logging Issues](https://github.com/Microsoft/azure-pipelines-task-lib/issues)
31+
32+
## Building the library
2733

2834
Once:
2935
```bash
@@ -41,6 +47,14 @@ Set environment variable TASK_TEST_TRACE=1 to display test output.
4147
[npm-lib-image]: https://img.shields.io/npm/v/azure-pipelines-task-lib.svg?style=flat
4248
[npm-lib-url]: https://www.npmjs.com/package/azure-pipelines-task-lib
4349

50+
## Powershell
51+
52+
We also maintain a PowerShell library for Windows task development.
53+
54+
Library: [Powershell Library](../powershell)
55+
56+
Usage: [Consuming the SDK](../powershell/Docs/Consuming.md)
57+
4458
## Third Party Notices
4559
To generate/update third party notice file run:
4660
```bash

0 commit comments

Comments
 (0)