Browse Source

update docs

[CI SKIP]
main
layla 2 months ago
parent
commit
28bfe9aa13
  1. 14
      CONTRIBUTING.md
  2. 3
      README.md

14
CONTRIBUTING.md

@ -1,6 +1,14 @@
# Contributing instructions (ELI5 edition)
To contribute, you'll need an account on https://git.chapo.chat.
1. Fork [the repository](https://git.chapo.chat/hexbear-collective/bulletins)
2. Go to your fork and open the post you want to edit (stored in
`content/post`).
3. Press "Edit File", make your desired edits, and commit your changes.
4. View the main repository again. You will see a button that says `New
Pull Request`, press it. Set it to `merge into:
hexbear-collective:main ... pull from: <your name here>:main`, and
press the `New Pull Request` button.
5. Summarise your changes and press `Create Pull Request`. It will then
be reviewed and possibly be merged.
Posts are stored in `content/post`. Open a file, press on the pencil
icon ("Edit File"), make your desired edits and submit a pull request.
[An example PR can be found here.](https://git.chapo.chat/hexbear-collective/bulletins/pulls/1)

3
README.md

@ -0,0 +1,3 @@
# Hexbear Bulletins
For basic contributing instructing, please read CONTRIBUTING.md.
Loading…
Cancel
Save