gren-lang/compiler
1
1
Fork 0
mirror of https://github.com/gren-lang/compiler.git synced 2024-08-17 12:31:00 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add contributing guidelines.

Browse Source
This commit is contained in:
Robin Heggelund Hansen 2022-09-02 10:24:33 +02:00
parent dfe645f819
commit dd4e593431
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -1,4 +1,20 @@
# Local development commands
# Contributing
Before starting to work on a feature or bug fix for Gren, it might be a good idea
to check if the change you're intending to make is a good fit for the project.
We use the `Help Wanted` tag on github issues to indicate that a PR would be
welcome. If you cannot find an issue for the change you're intending to make,
head over to our [Zulip](https://gren.zulipchat.com) and start a new topic for your
idea in either the `#language-design` or `#api-design` streams.
We like to talk things through before commiting to a change, so that's a good way to go about
suggesting new features. Also, we're a friendly bunch, so don't be afraid to say hi.
All PRs will be considered, but by going through the above process you increase
your chances for a merge significantly.
## Local development commands
- build: `cabal build -f dev`
- run tests: `cabal test -f dev`