Skip to content

Commit c3361d4

Browse files
authored
docs: 📝 add community health docs like contributing guides (#79)
# Description Added from template. No review needed.
1 parent b710d49 commit c3361d4

File tree

2 files changed

+87
-0
lines changed

2 files changed

+87
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, we pledge to respect
4+
all people who contribute through reporting issues, posting suggestions,
5+
updating any material, submitting pull requests, and other activities.
6+
7+
We are committed to making participation in this project a
8+
harassment-free experience for everyone, regardless of level of
9+
experience, gender, gender identity and expression, sexual orientation,
10+
disability, personal appearance, body size, race, ethnicity, age, or
11+
religion.
12+
13+
Examples of unacceptable behavior by participants include the use of
14+
sexual language or imagery, derogatory comments or personal attacks,
15+
trolling, public or private harassment, insults, or other unprofessional
16+
conduct.
17+
18+
Project maintainers have the right and responsibility to remove, edit,
19+
or reject comments, commits, code, wiki edits, issues, and other
20+
contributions that are not aligned to this Code of Conduct. Project
21+
maintainers who do not follow the Code of Conduct may be removed from
22+
the project team.
23+
24+
Instances of abusive, harassing, or otherwise unacceptable behavior may
25+
be reported by opening an issue or contacting one or more of the project
26+
maintainers.
27+
28+
This Code of Conduct is adapted from the Contributor Covenant
29+
(https://contributor-covenant.org), version 1.0.0, available at
30+
https://contributor-covenant.org/version/1/0/0/

CONTRIBUTING.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Contributing
2+
3+
## Issues and bugs :bug:
4+
5+
The easiest way to contribute is to report issues or bugs that you might
6+
find while reading through the website. You can do this by creating a
7+
[new](https://github.com/seedcase-project/guidebook/issues/new/choose)
8+
issue on our GitHub repository.
9+
10+
## Adding or modifying content :pencil2:
11+
12+
If you would like to contribute content, please check out our
13+
[guidebook](https://guidebook.seedcase-project.org/) for more specific
14+
details on how we work and develop. It is a regularly evolving document,
15+
so is at various states of completion.
16+
17+
To contribute to `guidebook`, you first need to install
18+
[uv](https://docs.astral.sh/uv/) and
19+
[justfile](https://just.systems/man/en/packages.html). We use uv and
20+
justfile to manage our project, such as to run checks and test the
21+
template. Both the uv and justfile websites have a more detailed guide
22+
on using uv, but below are some simple instructions to get you started.
23+
24+
It's easiest to install uv and justfile using
25+
[pipx](https://pypa.github.io/pipx/), so install that first. Then,
26+
install uv and justfile by running:
27+
28+
``` bash
29+
pipx install uv rust-just
30+
```
31+
32+
We keep all our development workflows in the `justfile`, so you can
33+
explore it to see what commands are available. To see a list of commands
34+
available, run:
35+
36+
``` bash
37+
just
38+
```
39+
40+
As you contribute, make sure your changes will pass our tests by opening
41+
a terminal so that the working directory is the root of this project's
42+
repository and running:
43+
44+
``` bash
45+
just run-all
46+
```
47+
48+
When committing changes, please try to follow [Conventional
49+
Commits](https://decisions.seedcase-project.org/why-conventional-commits)
50+
as Git messages. Using this convention allows us to be able to
51+
automatically create a release based on the commit message by using
52+
[Commitizen](https://decisions.seedcase-project.org/why-semantic-release-with-commitizen).
53+
If you don't use Conventional Commits when making a commit, we will
54+
revise the pull request title to follow that format, as we use [squash
55+
merges](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/squashing-commits/about-squash-merges)
56+
when merging pull requests, so all other commits in the pull request
57+
will be squashed into one commit.

0 commit comments

Comments
 (0)