Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
dennypradipta committed May 14, 2024
1 parent 02bdaca commit 1c1c17a
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
7 changes: 7 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
ISC License

Copyright 2023 Hyperjump

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Reviewer Assignment Tool

## Description

This project, the Reviewer Assignment Tool, is designed to automate the selection of reviewers for projects named Monika and Symon. It uses cryptographic randomness to ensure fair selection from a predefined list of reviewers, and notifies the selected reviewers via a Microsoft Teams webhook.

## Features

- Random selection of reviewers from a fixed list.
- Notification of selection results through Microsoft Teams.
- Environment variables for secure webhook integration.

## Installation

Install the necessary dependencies by running the following command:

```bash
npm install
```

## Usage

To run the tool, simply execute:

```bash
node index.js
```

This will select reviewers randomly and post the assignment details to a configured Microsoft Teams channel via a webhook.

## Configuration

Ensure that the TEAMS_WEBHOOK_URL environment variable is set to your Microsoft Teams webhook URL before running the script.

## Contributing

We welcome contributions from the community. Before you contribute, please read through the project documentation. If you wish to contribute, please fork the repository and submit a pull request.

- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request

# License

This project is licensed under the ISC License. See the LICENSE file in the repository for more information.

0 comments on commit 1c1c17a

Please sign in to comment.