Skip to content

Commit b9eb27a

Browse files
klardotshalexmv
authored andcommitted
docs: Add contribution guidelines based on zulip/zulip.
1 parent 01d19f8 commit b9eb27a

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,17 @@ This is a collection of GitHub Actions to interact with [Zulip](https://zulip.co
66

77
## Actions
88

9-
- [Sends a message to Zulip](./send-message/README.md)
9+
- [`zulip/github-actions-zulip/send-message@v1` sends a message to Zulip](./send-message/README.md)
10+
11+
## Contributing
12+
13+
These actions are implemented in TypeScript, see
14+
[`tsconfig.json`](./tsconfig.json) for (generally strict mode defaults)
15+
compiler settings. Use `npm run lint:fix` to autoformat all TypeScript and
16+
Markdown to the expected style. Use `npm run package` to generate
17+
`dist/**/*.js`, never edit those files by hand. Commits should follow [the
18+
Zulip Commit Discipline
19+
guide](https://zulip.readthedocs.io/en/latest/contributing/version-control.html),
20+
which can then be contributed upstream to this repository following the [Zulip
21+
Reviewable Pull Requests
22+
guide](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html)

0 commit comments

Comments
 (0)