Skip to content

Latest commit

 

History

History
101 lines (57 loc) · 6.1 KB

CONTRIBUTING.md

File metadata and controls

101 lines (57 loc) · 6.1 KB
Raw

Contribute to the Azure DevOps Demo Generator

Welcome, and thank you for your interest in contributing to the Azure DevOps Demo Generator!

We welcome participation in a variety of ways, including providing and commenting on issues, issuing pull requests against the code base for new features and fixes, updating and improving documentation, or by contributing templates. This document provides a high-level overview of how you can get involved.

About this project

The Azure DevOps Demo Generator is a service enabling you to provision Azure DevOps projects based on existing templates. It can be used to generate projects for hands-on-labs and learning, to setup a 'DevOps playground' to experiment and demonstrate, or to achieve other objectives (e.g., Microsoft Learning or the Microsoft Cloud Adoption Framework). You can also build custom templates to create templates for your own community or company, develop your own project creation tools using the REST API, or simply as reference example for working with the Azure DevOps APIs.

Note: The Azure DevOps Demo Generate was not designed for "copying" projects and attempts to do so will most likely fail.

Contribution Guidelines

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Contributing Templates

Once you successfully generate and test your template, you can share it with community. This can be done in three ways.

  1. Create a pull request to Azure DevOps Demo Generator
  2. Place the template zip file in any public repository and share the link in Email
  3. Share the template directly through Email

Note: If you have extensions installed in your organization, tempalte would be generated along with reference to all installed extensions in the Extensions.json file. You can edit this file and keep only the required extensions for the project. If extensions are not required, keep the file empty.

Your template must contian following elements

Keys Description
Name Name of your template, which will be displayed in the text box upon template selection
ShortName Short name for your template. This should not contain any space or special characters
TemplateFolder Name of your tempalte folder. This should not contain any space or special characters
Description A brief description about the template
Tags An array of tags, which should be related to technologies used. Ex: .NetCore, Java, Maven, Docker, K8S, etc.
Icon Templte icon to display it publicly in the tempalte selection page
Document link Document link for user reference

We will communicate via Email once the template validated successfully.

Asking Questions

Have a question? Open an issue using the question template and the question label.

The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.

Providing Feedback

Your comments and feedback are welcome, and the project team is available via handful of different channels.

Reporting Issues

Have you identified a reproducible problem in a workshop? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.

Look For an Existing Issue

Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.

Be sure to scan through the most popular feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Please use the template for each issue.

Final Checklist

Please remember to do the following:

  • Search the issue repository to ensure your report is a new issue

  • Recreate the issue after disabling all extensions

  • Simplify your code around the issue to better isolate the problem

Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

Contributing Fixes

If you are interested in writing code to fix issues, please see How to Contribute in the wiki.

Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.