Merge ~gabrielcocenza/juju-lint:contributing into juju-lint:master

Proposed by Gabriel Cocenza
Status: Merged
Approved by: Alvaro Uria
Approved revision: 0cf03021b0f4e7379455e4265d55897fcaa5cae3
Merged at revision: 112591bbc7cf5303743eadaccbec5442f2541cac
Proposed branch: ~gabrielcocenza/juju-lint:contributing
Merge into: juju-lint:master
Diff against target: 56 lines (+50/-0)
1 file modified
CONTRIBUTING.md (+50/-0)
Reviewer Review Type Date Requested Status
Alvaro Uria (community) Approve
Review via email: mp+423677@code.launchpad.net

Commit message

adding CONTRIBUTING.md to the project.

To post a comment you must log in.
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

Revision history for this message
Alvaro Uria (aluria) wrote :

+1

review: Approve
Revision history for this message
🤖 Canonical IS Merge Bot (canonical-is-mergebot) wrote :

Change successfully merged at revision 112591bbc7cf5303743eadaccbec5442f2541cac

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
0new file mode 1006440new file mode 100644
index 0000000..7e46600
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,50 @@
1# Contributing
2
3## Overview
4
5This documents explains the processes and practices recommended for contributing enhancements to
6this project.
7
8- Generally, before developing enhancements to this project, you should consider [report a bug
9 ](https://bugs.launchpad.net/juju-lint) explaining your use case.
10- All enhancements require review before being merged. Code review typically examines
11 - code quality
12 - test coverage
13 - documentation
14- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto
15 the `master` branch. This also avoids merge commits and creates a linear Git commit history.
16
17### Developing
18
19Clone this repository:
20```shell
21git clone git+ssh://<LAUNCHPAD_USER>@git.launchpad.net/juju-lint
22cd juju-lint/
23```
24
25You can use the environments created by `tox` for development:
26
27```shell
28tox --notest -e unit
29source .tox/unit/bin/activate
30```
31
32After making your changes you can run the CI without the need of building and installing the snap by using:
33
34```shell
35python3 -m jujulint.cli <PATH_TO_YAML> -c <PATH_TO_RULE_FILE> -l debug
36```
37
38
39### Testing
40
41```shell
42make lint # check code style
43make test # unit tests
44make build # build the snap
45make clean # clean the snapcraft lxd containers
46```
47
48## Canonical Contributor Agreement
49
50Canonical welcomes contributions to the juju-lint. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.

Subscribers

People subscribed via source and target branches