Skip to content

Commit

Permalink
Add/restore CONTRIBUTING.md
Browse files Browse the repository at this point in the history
It just links to our actual docs and repeats the passage from README.

I find that I often automatically scan for a `CONTRIBUTING.md` file in
the repo and get annoyed when it's hard to find. This should be helped
by the previus commit, but this will hopefully go further in putting
everyone on a road leading to Rome as quickly as possible.

This will also hopefully mean that more people read the instructions on
our website rather than GitHub, which will be a somewhat nicer
experience after #4822.
  • Loading branch information
ilyagr committed Nov 15, 2024
1 parent 2535a3b commit 7f18fb2
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Thanks for your interest for contributing to `jj`! See <https://martinvonz.github.io/jj/prerelease/contributing/>
for detailed instructions[^md].

[^md]: Those docs are generated from
[`docs/contributing.md`](docs/contributing.md).

The broad TL;DR is:

<!-- Keep this section in sync with https://github.com/martinvonz/jj?tab=readme-ov-file#contributing -->

- Bug reports are very welcome!
- Every commit that lands in the `main` branch is code reviewed.
- Please behave yourself, and obey the Community Guidelines.
- There **is** a mandatory CLA you must agree to. Importantly, it **does not**
transfer copyright ownership to Google or anyone else; it simply gives us the
right to safely redistribute and use your changes.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,8 @@ We do have [a few policies and
suggestions](https://martinvonz.github.io/jj/prerelease/contributing/)
for contributors. The broad TL;DR:

<!-- Keep this section in sync with CONTRIBUTING.md -->

- Bug reports are very welcome!
- Every commit that lands in the `main` branch is code reviewed.
- Please behave yourself, and obey the Community Guidelines.
Expand Down

0 comments on commit 7f18fb2

Please sign in to comment.