|
1 | 1 | # Contributing to HaskellDO
|
2 | 2 |
|
3 |
| -As of right now, we're just releasing something we think is good enough to get |
4 |
| -going with, but the community is who really has the ability to bring an idea like |
5 |
| -this into focus and build it into something amazing. Though there are a few guidelines we'd like our contributors to follow so that we can keep on top of things and streamline the PR process. |
6 |
| - |
7 |
| -# HaskellDO Core vs GUI |
8 |
| -Right now HaskellDO is separated into two modules. The `core` module holds the backend and engine of HaskellDO. `core` is written in Haskell and focuses primarily on interacting with notebooks received from the frontend. Anything that directly impacts a notebook or project, say adding `git` commands to HaskellDO, should be done in `core`. |
9 |
| -The `gui` module holds the frontend of HaskellDO. Right now it is written in PureScript, though we are thinking about converting it all to Haskell at a later date. Any GUI changes, QOL improvements, etc, should be changed in `gui`. |
10 |
| - |
11 | 3 | # Getting Started
|
12 | 4 | * Create a [GitHub](https://github.com) account if you do not already have one
|
13 | 5 | * Check if a ticket for your issue exists, if not create one
|
14 |
| - * Make sure your ticket details the issue and the steps to reproduce the bug |
15 |
| - * If your ticket proposes a new feature for HaskellDO, please provide an explanation of the feature, what problem is solves, and possible use cases |
| 6 | + * Make sure your ticket details the issue and the steps to reproduce the bug |
| 7 | + * If your ticket proposes a new feature for haskell.do, please provide an explanation of the feature, what problem it solves, and possible use cases |
16 | 8 | * Fork the repository on GitHub
|
17 | 9 |
|
18 | 10 | # Changing HaskellDO
|
19 |
| -* Create a branch to work on your feature with a descriptive name |
20 |
| - * Generally branched off of `master` |
| 11 | +* Create a branch from `master` to work on your feature with a descriptive name |
21 | 12 | * Make commits frequently with descriptive comments (detailed below)
|
22 | 13 | * Add tests to ensure proper functionality
|
23 | 14 | * Please do not submit until all tests are passed
|
24 | 15 |
|
25 |
| -Commit messages should stick to the following format: (issue number) issue name description |
| 16 | +Commit messages should stick to the following format: `(issue number) issue name description` |
26 | 17 |
|
27 | 18 | E.g:
|
28 | 19 |
|
29 | 20 | ```
|
30 |
| -(HD-01) Example issue |
31 |
| -Steps to recreate: etc |
| 21 | +Example issue |
| 22 | +Steps to recreate: |
| 23 | +- Put toast in oven |
| 24 | +- Turn oven off |
| 25 | +- ???? |
32 | 26 |
|
33 | 27 | An issue would then here go into detail describing the issue, and perhaps even suggesting a fix
|
34 | 28 | ```
|
35 | 29 |
|
36 | 30 | # Making Small Changes
|
37 | 31 | When changing things like documentation, it is not always necessary to create a ticket. Instead simply add the documentation, and send a PR with a message of the following form:
|
| 32 | + |
38 | 33 | ```
|
39 | 34 | (doc) Added documentation to <file-name>
|
40 | 35 | <file-name> lacked proper documentation on how <function> works.
|
| 36 | +
|
41 | 37 | This commit adds documentation describing <function>, and provides various examples.
|
42 | 38 | ```
|
43 | 39 |
|
44 | 40 | # Submitting Changes
|
45 | 41 | * Push your changes to the branch in your fork of the repository
|
46 | 42 | * Submit a pull request
|
47 |
| -* The HaskellDO team will review your PR as quickly and provide feedback |
| 43 | +* The haskell.do team will review your PR as quickly and provide feedback |
48 | 44 | * After receiving feedback, either make the required changes, or your branch will be merged
|
49 | 45 |
|
50 |
| -Thanks for contributing to HaskellDO, happy hacking! |
| 46 | +Thanks for contributing to haskell.do, happy hacking! |
0 commit comments