diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20e88bc..0ccc471 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,232 @@ -# Contributing +# Contributing to the hpc-libs repository -To make contributions to this charm, you'll need a working [development setup](https://juju.is/docs/sdk/dev-setup). +Do you want to contribute to the hpc-libs charm libraries? You've come to +the right place then! __Here is how you can get involved.__ -You can create an environment for development with `tox`: +Please take a moment to review this document so that the contribution +process will be easy and effective for everyone. Also, please familiarise +yourself with the [Juju SDK](https://juju.is/docs/sdk) as it will help you +better understand how the charm libraries are put together. -```shell -tox devenv -e integration -source venv/bin/activate -``` +Following these guidelines helps you communicate that you respect the maintainers +managing the libraries. In return, they will reciprocate that respect +while addressing your issue or assessing your submitted changes and/or features. -## Testing +Have any questions? Feel free to ask them in the [Ubuntu High-Performance Computing +Matrix chat](https://matrix.to/#/#hpc:ubuntu.com). -This project uses `tox` for managing test environments. There are some pre-configured environments -that can be used for linting and formatting code when you're preparing contributions to the charm: +### Table of Contents -```shell -tox run -e format # update your code according to linting rules -tox run -e lint # code style -tox run -e static # static type checking -tox run -e unit # unit tests -tox run -e integration # integration tests -tox # runs 'format', 'lint', 'static', and 'unit' environments -``` +* [Using the issue tracker](#using-the-issue-tracker) +* [Issues and Labels](#issues-and-labels) +* [Bug Reports](#bug-reports) +* [Enhancement Proposals](#enhancement-proposals) +* [Pull Requests](#pull-requests) +* [Discussions](#discussions) +* [Code Guidelines](#code-guidelines) +* [License](#license) -## Build the charm +## Using the issue tracker -Build the charm in this git repository using: +The issue tracker is the preferred way for tracking [bug reports](#bug-reports), [enhancement proposals](#enhancement-proposals), +and [submitted pull requests](#pull-requests), but please follow these guidelines for the issue tracker: -```shell -charmcraft pack -``` +* Please __do not__ use the issue tracker for personal issues and/or support requests. +The [Discussions](#discussions) page is a better place to get help for personal support requests. -