Skip to content

Commit a269005

Browse files
committedAug 31, 2020
Add associated docs
1 parent 60b5cfc commit a269005

File tree

3 files changed

+127
-0
lines changed

3 files changed

+127
-0
lines changed
 

‎CODE_OF_CONDUCT.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported to project admins via email - Carolyn Van Slyck (`me@carolynvanslyck.com`)
59+
- or via direct message in [Slack] to Carolyn Van Slyck (`@carolynvs`) or Jeremy Rickard (`@Jeremy Rickard`).
60+
All complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The project team is
62+
obligated to maintain confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org
75+
[slack]: https://porter.sh/community/#slack

‎CONTRIBUTING.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing Guide
2+
3+
This is part of the [Porter][porter] project. If you are a new contributor,
4+
check out our [New Contributor Guide][new-contrib]. The Porter [Contributing
5+
Guide][contrib] also has lots of information about how to interact with the
6+
project.
7+
8+
[porter]: https://github.com/deislabs/porter
9+
[new-contrib]: https://porter.sh/contribute
10+
[contrib]: https://github.com/deislabs/porter/blob/main/CONTRIBUTING.md
11+
12+
---
13+
14+
* [Initial setup](#initial-setup)
15+
* [Makefile explained](#makefile-explained)
16+
17+
---
18+
19+
# Initial setup
20+
21+
You need to have [porter installed](https://porter.sh/install) first. Then run
22+
`make build install`. This will build and install the mixin into your porter
23+
home directory.
24+
25+
## Makefile explained
26+
27+
Here are the most common Makefile tasks
28+
29+
* `build` builds both the runtime and client.
30+
* `install` installs the mixin into **~/.porter/mixins**.
31+
* `test-unit` runs the unit tests.
32+
* `clean-packr` removes extra packr files that were a side-effect of the build.
33+
Normally this is run automatically but if you run into issues with packr,
34+
run this command.
35+

‎REVIEWING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Reviewing Guide
2+
3+
This is part of the [Porter][porter] project and follows the Porter [Reviewing
4+
Guide][review].
5+
6+
[porter]: https://github.com/deislabs/porter
7+
[review]: https://github.com/deislabs/porter/blob/main/REVIEWING.md
8+
9+
## Cut a release
10+
11+
🧀💨
12+
13+
All mixins follow the same process for [cutting a release][release]. There is an additional step after tagging the release. When any documenation on the readme is changed, update the matching documenation page for the mixin on the porter website:
14+
15+
https://github.com/deislabs/porter/tree/main/docs/content/mixins
16+
17+
[release]: https://github.com/deislabs/porter/blob/main/REVIEWING.md#cut-a-release

0 commit comments

Comments
 (0)