Skip to content

Commit

Permalink
docs: contributing.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
quisquous committed Dec 20, 2023
1 parent 261a217 commit cf32625
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,9 @@ here's a set of features that will almost always be needed:
* [issues marked "help wanted"](https://github.com/quisquous/cactbot/issues?utf8=%E2%9C%93&q=label%3A%22help+wanted%22)
* [adding missing timelines](https://github.com/quisquous/cactbot/issues/414)
* missing translations
* [trigger future work](docs/RaidbossGuide.md#future-work)
* [timeline future work](docs/TimelineGuide.md#future-work)
* [oopsy future work](docs/OopsyraidsyGuide.md#future-oopsy-work)

## Trigger Guidelines

Expand All @@ -263,3 +266,9 @@ See: [Oopsy Guide](docs/OopsyraidsyGuide.md#overview)
* Improvements and additions to documentation are always welcome.
* Use [semantic line breaks](https://sembr.org/).
* As always, be consistent!

## How to Release

Run `npm version patch` or `npm version minor` to add a local commit with a version change.
Upload this PR.
Merge the PR and a release will happen.
8 changes: 8 additions & 0 deletions docs/RaidbossGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -1118,3 +1118,11 @@ See: [P12S First Wing](https://github.com/quisquous/cactbot/blob/main/ui/raidbos
[P12S Wing Followup](https://github.com/quisquous/cactbot/blob/main/ui/raidboss/data/06-ew/raid/p12s.ts#:~:text=id%3A%20%27P12S%20Wing%20Followup%27)

See also: [AMR Moko Triple Kasumi-giri triggers](https://github.com/quisquous/cactbot/blob/main/ui/raidboss/data/06-ew/dungeon/another_mount_rokkon.ts)

## Future Work

- make it easier to find fights and options in the cactbot config (it's kind of tedious now)
- add "shared outputstrings" to a trigger set so multiple triggers can use the same set, there's less translation duplication, and users don't have to add overrides everywhere
- similarly make it possible to share config overrides in criterion vs criterion savage
- raidemulator: show multiple trigger outputs from the same trigger: <https://github.com/quisquous/cactbot/issues/5490>
- raidemulator: fix resetting issues: <https://github.com/quisquous/cactbot/issues/5714>

0 comments on commit cf32625

Please sign in to comment.