Skip to content

Commit

Permalink
Updating documentation (#461)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Danny McCormick authored Feb 14, 2019
1 parent 2c65560 commit debde2a
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Instructions for Contributing Code

## Contributing bug fixes

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.

## Contributing features

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.

Design changes will not be accepted at this time. If you have a design change proposal, please log a suggestion issue.

## Legal

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.

Please submit a Contributor License Agreement (CLA) before submitting a pull request. You may visit https://cla.microsoft.com to sign digitally.

## Housekeeping

Your pull request should:

* Include a description of what your change intends to do
* Be a child commit of a reasonably recent commit in the **master** branch
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR)
* It is desirable, but not necessary, for the tests to pass at each commit
* Have clear commit messages
* e.g. "Refactor feature", "Fix issue", "Add tests for issue"
* Include adequate tests
* 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
* Tests should include reasonable permutations of the target fix/change
* Include baseline changes with your change
* All changed code must have 100% code coverage
23 changes: 23 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Please check our current Issues to see if someone already reported this https://github.com/Microsoft/azure-pipelines-task-lib/issues

### Environment
azure-pipelines-task-lib version:

### Issue Description
<!--- Please provide a short description of the issue -->

### Expected behaviour
<!--- Tell us what should happen -->

### Actual behaviour
<!--- Tell us what happens instead -->

### Steps to reproduce
1.
2.
3.
4.
5.

### Logs
<!-- Any logs you have/stack traces/etc. -->
16 changes: 15 additions & 1 deletion node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ The [ShellScript Task](https://github.com/Microsoft/azure-pipelines-tasks/tree/m

## Contributing

### Node
We are accepting contributions and we try to stay on top of issues.

[Contribution Guide](../CONTRIBUTING.md).

[Logging Issues](https://github.com/Microsoft/azure-pipelines-task-lib/issues)

## Building the library

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

## Powershell

We also maintain a PowerShell library for Windows task development.

Library: [Powershell Library](../powershell)

Usage: [Consuming the SDK](../powershell/Docs/Consuming.md)

## Third Party Notices
To generate/update third party notice file run:
```bash
Expand Down

0 comments on commit debde2a

Please sign in to comment.