Skip to content

Commit

Permalink
docs(contrib): hid old contributing docs in details block
Browse files Browse the repository at this point in the history
They'll still be there while we transition over to the new system though.
  • Loading branch information
arctic-hen7 committed Jan 16, 2022
1 parent 36abcc1 commit 6f850c2
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

First off, thanks so much for taking the time to contribute to Perseus, it's greatly appreciated!

Perseus uses [Tribble](https://github.com/arctic-hen7/tribble) for managing contributions, see [here](https://arctic-hen7.github.io/perseus/tribble/workflow/perseus) for an interactive system that will guide you through making contributions to this repository. Please note that this system is still in beta, so please just open a GitHub issue as usual if something's not working properly there. Otherwise, issues should be created through Tribble.
Perseus uses [Tribble](https://github.com/arctic-hen7/tribble) for managing contributions, see [here](https://arctic-hen7.github.io/perseus/tribble/workflow/perseus) for an interactive system that will guide you through making contributions to this repository. Please note that this system is still in beta, so please just open a GitHub issue as usual if something's not working properly there. Otherwise, issues should be created through Tribble (this allows you to basically triage your issue yourself, making things move more quickly).

The rest of this document is dedicated to explaining how to get a local copy of Perseus and open a pull request, and is primarily targeted toward those contributing to an open-source project for the first time.

Expand All @@ -27,10 +27,13 @@ Once you've made your changes to your local copy and committed them with Git, yo

Once you've submitted your PR, we'll try to get to reviewing it as quickly as possible! Unfortunately, not every pull request can be merged, but we'll do our best to request changes so that yours can be best integrated into the project.

# Old Details
## Old Details

This section pre-dates the usage of Tribble, but it will very soon be made obsolete. During the transition, this information will still be available.

<details>
<summary>Click here to see the old details.</summary>

## Building

Perseus uses [Bonnie](https://github.com/arctic-hen7/bonnie) for command aliasing (you can install it with `cargo install bonnie`), and most of the project testing is done in the `examples` directory. You can run `bonnie help` to see all available commands, but this is the one you'll use the most:
Expand Down Expand Up @@ -77,3 +80,5 @@ A separate branch is created for new features/fixes, which are then merged into
We use the Conventional Commits system, but you can commit however you want. Your pull request will be squashed and merged into a single compliant commit, so don't worry about this!

We do request though that you make sure your commits are signed with GPG, it helps verify the integrity of your code, and is good practice generally.

</details>

0 comments on commit 6f850c2

Please sign in to comment.