Merge pull request #1859 from Chris-Peterson444/update-readme-contribution-requirements

readme: make a contributing section and point to CONTRIBUTING.md
This commit is contained in:
Chris Peterson 2023-11-09 11:35:41 +02:00 committed by GitHub
commit 7f3c137ba3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 40 additions and 9 deletions

View File

@ -1,13 +1,40 @@
Thank you for considering a contribution to Subiquity. Here's what we like to Thank you for considering a contribution to Subiquity. Here are some things to
see: note:
* Contributors will need to have signed the ## Code of Conduct
[CLA](https://ubuntu.com/legal/contributors/agreement).
* Format, lint, unit, integration, and API tests should be passing. This project is subject to the [Ubuntu Code of Conduct](https://ubuntu.com/community/code-of-conduct)
* format - either run `make format` or `pre-commit install`. to foster an open and welcoming place to contribute. By participating in the
See [pre-commit](https://pre-commit.com/#install) for more details on that project (in the form of code contributions, issues, comments, and other
tool. activities), you agree to abide by its terms.
## Contributor License Agreement
This project is subject to the
[Canonical contributor license agreement](https://ubuntu.com/legal/contributors),
please make sure you have [signed it](https://ubuntu.com/legal/contributors/agreement)
before (or shortly after) submitting your first pull request.
A github workflow will verify that your GitHub username or email address is
associated with a contributor license agreement signature, but it may take
some time after your initial signature for the check to see it. If you're
part of [@canonical](https://github.com/canonical), you will also need to make
sure your canonical.com email address is associated with your GitHub account.
## Bugs
Bugs are tracked on [Launchpad](https://bugs.launchpad.net/subiquity). It is
recommended you use `ubuntu-bug` (or similar) to let apport collect relevant
logs which are helpful for the debug process, instead of filing one directly.
## Pull Requests
Changes to this project should be proposed as pull requests on GitHub at:
[https://github.com/canonical/subiquity/](https://github.com/canonical/subiquity/)
Format, lint, unit, integration, and API tests should be passing.
* format - run either `make format` or `pre-commit install`.
* Install pre-commit with `sudo apt install pre-commit`.
* all the rest - `make lint check`. * all the rest - `make lint check`.
Prerequisites for running these locally can be installed with * Prerequisites for running these locally can be installed with
`make aptdeps`. `make aptdeps`.

View File

@ -125,3 +125,7 @@ parts:
``` ```
The first three steps are bundled into the script ./scripts/test-this-branch.sh. The first three steps are bundled into the script ./scripts/test-this-branch.sh.
# Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md)