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