Skip to content

Commit

Permalink
Merge pull request instructlab#17 from vishnoianil/readme
Browse files Browse the repository at this point in the history
Update project readme file with meeting, slack and maintainers details
  • Loading branch information
nerdalert authored Jun 21, 2024
2 parents d90b384 + c3ae19f commit a6d423f
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 9 deletions.
1 change: 1 addition & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
For a complete list of InstructLab project maintainers, see [Maintainers](https://github.com/instructlab/community/blob/main/MAINTAINERS.md).
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
# InstructLab UI

A GitHub UI to increase contributor test and review velocity for
[instructlab/taxonomy](https://github.com/instructlab/taxonomy).
Project aims to provide a UI based interface to the contributors and reviewers to submit and review contribution to [instructlab/taxonomy](https://github.com/instructlab/taxonomy).
The intention is to simplify the process of contribution by providing a user friendly interface, that doesn't require the user to have a deep understanding of tools required to contribute skill and knowledge to the taxonomy. This project also aims to provide a platform for the reviewers to efficiently review the contributions and provide feedback to the contributors.

## Overview

Personas:
Current scope of the project is to work on following personas:

- Taxonomy **Contributor**
- Taxonomy **Triager**
- Taxonomy **Contributor**: Person who wants to contribute a skill or a knowledge to the taxonomy.
- Taxonomy **Triager**: Person who has expertise to review the contributions and provide feedback to the contributors.

The technical overview and developer docs for getting started can be found [here](docs/development.md).

## Contributing

If you have suggestions for how instructlab/ui could be improved, or want to
report a bug, open an issue! We'd love all and any contributions.
report a bug, open an [issue](https://github.com/instructlab/ui/issues)! We'd love all and any contributions.

For more, check out the [InstructLab Bot Contribution Guide](CONTRIBUTING.md)
and [InstructLab
Community](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md).
For more, check out the [InstructLab UI Contribution Guide](CONTRIBUTING.md)
and [InstructLab Community Guide](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md).

## Community Meeting

We have a weekly community meeting to discuss the project and contributions. Meeting happens **every Wednesday 10AM PST**.
Please subscribe to the InstructLab Community Calendar following the instructions [here](https://github.com/instructlab/community/blob/main/Collaboration.md). UI project meeting details are present in the calendar event.

## Slack channel

Please subscribe to the InstructLab Slack workspace by following the instructions [here](https://github.com/instructlab/community/blob/main/Collaboration.md#chat). Once you are part of the workspace, you can join the `#ui` channel where most of the project related topics are discussed.

## License

Expand Down

0 comments on commit a6d423f

Please sign in to comment.