Skip to content
This repository was archived by the owner on May 28, 2024. It is now read-only.

Commit e574b3c

Browse files
author
Christine Dodrill
committed
documentation updates
1 parent d5351fe commit e574b3c

File tree

2 files changed

+176
-1
lines changed

2 files changed

+176
-1
lines changed

‎CODE_OF_CONDUCT.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, religion, or sexual identity
11+
and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the
27+
overall community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or
32+
advances of any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email
36+
address, without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official e-mail address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.
130+

‎doc/README.md ‎README.md

+46-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# palisade
22

3+
[![built with
4+
nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)
5+
[![written in rust](https://img.shields.io/badge/language-Rust-orange)](https://www.rust-lang.org/)
6+
37
A simple release automation tool for GitHub repos
48

59
Palisade ([IPA][ipa]: /pæl əˈseɪd/) is a tool that reads from changelog and
@@ -8,6 +12,47 @@ to be run by CI tools on every commit to master.
812

913
[ipa]: https://en.wikipedia.org/wiki/International_Phonetic_Alphabet
1014

15+
## Build Instructions
16+
17+
### With Nix
18+
19+
If you have [Nix](https://nixos.org/nix) installed, you can run the following
20+
command to build this software:
21+
22+
```console
23+
$ nix-build
24+
```
25+
26+
This will automatically create a release build linked to `./result`. The binary
27+
will be `./result/bin/palisade`.
28+
29+
### With Cargo
30+
31+
```console
32+
$ cargo build --release
33+
```
34+
35+
## Hacking
36+
37+
If you are using Nix, [direnv](https://direnv.net/) and
38+
[Lorri](https://github.com/target/lorri), you can get an exact replica of the
39+
required development environment by running `direnv allow` in the checkout of
40+
this project. See [this
41+
blogpost](https://christine.website/blog/how-i-start-nix-2020-03-08) for more
42+
information on how to install Nix if you want to try this workflow out.
43+
44+
If you are not using Nix, you need at least the following dependencies:
45+
46+
- Rust 1.43 or newer
47+
- libgit2 (newest if possible)
48+
- libiconv (should be part of glibc on linux)
49+
- openssl and its development headers
50+
- pkg-config
51+
52+
Details on how to do this will be distribution specific. Please consult the
53+
documentation of your package manager and operating system to figure out the
54+
list of packages you will need.
55+
1156
## Raison d'Être
1257

1358
Existing automated release scripts for our GitHub repos have been flaky and have
@@ -60,7 +105,7 @@ code of your project, exposing something normally hidden in git to your team.
60105

61106
[semver]: https://semver.org/spec/v2.0.0.html
62107

63-
## Release Process
108+
### How It Works
64109

65110
When this tool is run with the `cut` subcommand, the following actions take place:
66111

0 commit comments

Comments
 (0)