https://github.com/joachimdalen/azdevops-acceptance-criterias
An extension to manage acceptance criterias
https://github.com/joachimdalen/azdevops-acceptance-criterias
acceptance-criteria azure-boards azure-devops azure-devops-extension hacktoberfest
Last synced: 5 months ago
JSON representation
An extension to manage acceptance criterias
- Host: GitHub
- URL: https://github.com/joachimdalen/azdevops-acceptance-criterias
- Owner: joachimdalen
- License: mit
- Created: 2021-11-18T14:49:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-29T07:13:19.000Z (over 3 years ago)
- Last Synced: 2023-03-02T23:51:19.369Z (over 3 years ago)
- Topics: acceptance-criteria, azure-boards, azure-devops, azure-devops-extension, hacktoberfest
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=joachimdalen.acceptance-criterias
- Size: 1.46 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Acceptance Criterias
An extension to manage acceptance criterias
Explore the docs »
View Extension
·
Changelog
·
Report Bug
·
Request Feature
---
## About The Project
Accepance Criterias is an extension to allow for better management of acceptance criterias in Azure DevOps.
## Features
- Several criteria types
- Scenario based
- Text based
- Checklist based
- Approval and rejection flows
- Hub for processing criterias
- Approval / Rejection comments
- Processing history
### On the roadmap
- [Auto assign approver based on rules](https://github.com/joachimdalen/azdevops-acceptance-criterias/issues/8)
- [Ability to assign tags to a criteria](https://github.com/joachimdalen/azdevops-acceptance-criterias/issues/7)
- [Excel/CSV export](https://github.com/joachimdalen/azdevops-acceptance-criterias/issues/2)
## Getting Started
### Prerequisites
- A MarketPlace publisher [Create a publisher](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#create-a-publisher)
- `tfx-cli` installed. Due to issues with outdated dependencies this is not included in `package.json`
```sh
npm install -g tfx-cli
```
- Pipelines uses the following extensions that needs to be installed in your organization in addition to default tasks:
- [GitGuard](https://marketplace.visualstudio.com/items?itemName=joachimdalen.gitguard) - Used to verify changes to files, such as changelog.
- [Azure DevOps Extension Tasks](https://marketplace.visualstudio.com/items?itemName=ms-devlabs.vsts-developer-tools-build-tasks) - Used to build and publish extension.
### Installation
1. Clone the repo
```sh
git clone https://github.com/joachimdalen/azdevops-acceptance-criterias.git
```
2. Install dependencies
```sh
> npm install
```
3. Update publisher in `vss-extension.dev.json`
4. Compile development version
```sh
npm run prepare:dev
```
5. [Publish extension](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#publish-an-extension)
6. [Share](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#share-an-extension) and [install](https://docs.microsoft.com/en-us/azure/devops/extend/publish/overview?view=azure-devops#install-an-extension) extension
7. Run extension
```sh
npm run serve:dev
```
**Note:** You might need to open [https://localhost:3000/](https://localhost:3000/) in your browser from time to time to accept the unsecure certificate to have the extension load properly from your local environment.
## Usage
See [documenation](./docs/index.md) for rule usage.
## Roadmap
See the [open issues](https://github.com/joachimdalen/azdevops-acceptance-criterias/issues?q=is%3Aopen+is%3Aissue+label%3A%40type%2Ffeature) for a full list of proposed features.
## Contributing
Contributions are welcome, both in the form of suggestions and code. Create
If you want to contribute code, I ask that you follow some guidelines.
- New and changed features should to the best ability be covered by tests
- Follow the branching policy:
- `feature/` for new features
- `bugfix/` for bug fixes
- `docs/` for documentation changes
- If your change is related to an issue, use the id as the first part of the branch e.g `bugfix/12-fix-crash-when-updating-rule`
- Pull requests should target the `main` branch
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Release and merge strategy
- `main` is only deployed to `PROD` and tagged with `v`
- Pull requests are always squash merged into `main`
- `main` is the only branch where GitHub releases are created for
- `feature/*` and `bugfix/*` are deployed to `QA`. For deployment to `DEV` using local assets (only manifest changes are deployed to dev), the `Deploy to DEV instead of QA` option needs to be checked when running the deployment pipeline.
`QA` and `DEV` are private development and verfication environments (publications of the extensions.) Submit a new issue if you for some reason wish access to either of these.
**Note** Access to these are not given for your local development. Please publish your own development release.
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
If you have generic questions about the project or usage you can make contact in the following ways:
- Submit an issue with the `@type/question` label - [New Issue](https://github.com/joachimdalen/azdevops-acceptance-criterias/issues/new)
- Submit a new question under the [Marketplace Q&A section](https://marketplace.visualstudio.com/items?itemName=joachimdalen.acceptance-criterias&ssr=false#qna).