Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 5.92 KB

CONTRIBUTING.md

File metadata and controls

109 lines (80 loc) · 5.92 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • Your version of Azure DevOps (if known) and if it is hosted or in house
  • Anything unusual about your environment

Building

  1. Clone the repo or your fork with git clone
  2. Change to the directory you cloned to, and run npm install
  3. At this point you can:
  • Build for testing purposes. Run npm run fullBuild
  • Package for installation into Azure DevOps. Run npm run fullBuild publisher=<your-publisher-id-here> Azure DevOps uses this publisher ID to determine if a plugin can be installed, so make sure it matches the one in your Azure DevOps instance.

Project Architecture

The project is split into Tasks, under the Tasks folder, like CloudFormationCreateOrUpdate as an example. Each Task looks like:

           System environment
+------+        ^
| Task |        |  Reads from
+------+--------------------------------------------------------+
|               |                                               |
|               |                    +---------------------+    |
|               |                    | Utils (like CFUtils)|    |
|               |                    +--------^------------+    |
|         +-----+--------------+              |  Calls          |
|         |   Task Parameters  |              |                 |
|         +-----+--------------+          +---+-------------+   |
|               ^                         | Task Operations |   |
|   Constructs  |                         +-------^---------+   |
|               |                                 |             |
|               |       +-----------------+       |             |
|               +-------+    Task Runner  +-------+ Runs        |
|                       |  (generated)    |                     |
|                       +------^----------+                     |
|                              |                                |
+---------------------------------------------------------------+
                               |
                         Runs  |
                               |
                               |
            Azure DevOps Agent |
                               +

Each task is specified in vss-extension.json with a description, as well as information about the extension itself.

Contributing via Pull Requests

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

  1. You are working against the latest source on the master branch.
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.

To send us a pull request, please:

  1. Fork the repository.
  2. Modify the source; please focus on the specific change you are contributing.
    • Please follow the instructions in Building to ensure your changes will be formatted properly (npm install installs a code formatter)
  3. Ensure local tests pass.
  4. Once you are done with your change, run npm run newChange, follow the prompts, then commit the changelog item to your fork.
  5. Make sure to add tests to your change
  6. Commit to your fork using clear commit messages.
  7. Send us a pull request, answering any default questions in the pull request interface.
  8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional documentation on forking a repository and creating a pull request.

Testing locally

We are still working out a good way to do this beyond writing tests.

If you have a test Azure DevOps server, you can upload the packaged plugin from "\package". Keep in mind that Azure DevOps expects you to bump the version number (located in _package.json) every time you upload a new plugin. It also checks that your publisher ID matches the publisher ID of the plugin.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. Looking at any 'help wanted' or 'technical debt' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Licensing

See the LICENSE file for our project's licensing. We will ask you confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.