Skip to content

Commit 20cef93

Browse files
Updated HACKING to make the process clearer
1 parent bfb0c88 commit 20cef93

File tree

1 file changed

+37
-22
lines changed

1 file changed

+37
-22
lines changed

HACKING.md

Lines changed: 37 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,58 @@ How to make changes
1111

1212
### Fork and download the repository
1313

14-
1. Create a fork by clicking `Fork` button at the top right of the [repository](https://github.com/agda/agda-stdlib).
14+
1. Create a fork by clicking `Fork` button at the top right of the
15+
[repository](https://github.com/agda/agda-stdlib).
1516

16-
2. If you are on a Mac, make sure that your git options has `autocrlf` set to `input`. This can be done by executing
17+
2. If you are on a Mac, make sure that your git options has `autocrlf`
18+
set to `input`. This can be done by executing
1719
```
1820
git config --global core.autocrlf input
1921
```
20-
If you are on Windows, make sure that your editor can deal with Unix format files.
22+
If you are on Windows, make sure that your editor can deal with Unix
23+
format files.
2124

22-
3. On the command line, and in a suitable folder, download your fork by running the command
25+
3. On the command line, and in a suitable folder, download your fork by
26+
running the command
2327
```
2428
git clone https://github.com/USER_NAME/agda-stdlib agda-stdlib-fork
2529
```
2630

27-
where `USER_NAME` is your Git username. The folder `agda-stdlib-fork` should now contain a copy of the standard library.
31+
where `USER_NAME` is your Git username. The folder `agda-stdlib-fork`
32+
should now contain a copy of the standard library.
2833

29-
4. Enter the folder `agda-stdlib-fork` and choose the correct branch of the library to make your changes on by running the
30-
command
34+
4. Enter the folder `agda-stdlib-fork` and choose the correct branch of
35+
the library to make your changes on by running the command
3136
```
3237
git checkout X
3338
```
34-
where `X` should be `master` if your changes are compatible with the current released version of Agda, and `experimental`
35-
if your changes require the development version of Agda.
39+
where `X` should be `master` if your changes are compatible with the
40+
current released version of Agda, and `experimental` if your changes
41+
require the development version of Agda.
3642

3743
### Make your changes
3844

39-
5. Make your proposed changes. Please try to obey existing conventions in the library.
40-
See `agda-stdlib-fork/notes/style-guide.md` for a selection of the most important ones.
45+
5. Make your proposed changes. Please try to obey existing conventions
46+
in the library. See `agda-stdlib-fork/notes/style-guide.md` for a
47+
selection of the most important ones.
4148

4249
6. Document your changes in `agda-stdlib-fork/CHANGELOG.md`.
4350

44-
7. Ensure your changes are compatible with the rest of the library by running the commands
51+
7. Ensure your changes are compatible with the rest of the library by
52+
running the commands
4553
```
4654
make clean
4755
make test
4856
```
49-
inside the `agda-stdlib-fork` folder. Continue to correct any bugs thrown up until the tests are passed.
57+
inside the `agda-stdlib-fork` folder. Continue to correct any bugs
58+
thrown up until the tests are passed.
5059

51-
Your proposed changes MUST pass these tests. Note that the tests require the use of a tool called
52-
`fix-agda-whitespace`. See the instructions at the end of this file for how to install this.
60+
Your proposed changes MUST pass these tests. Note that the tests
61+
require the use of a tool called `fix-agda-whitespace`. See the
62+
instructions at the end of this file for how to install this.
5363

54-
If you are creating new modules, please make sure you are having a proper header,
55-
and a brief description of what the module is for, e.g.
64+
If you are creating new modules, please make sure you are having a
65+
proper header, and a brief description of what the module is for, e.g.
5666
```
5767
------------------------------------------------------------------------
5868
-- The Agda standard library
@@ -61,10 +71,10 @@ How to make changes
6171
------------------------------------------------------------------------
6272
```
6373

64-
6574
### Upload your changes
6675

67-
8. Use the `git add` command to add the files you have changed to your proposed commit.
76+
8. Use the `git add X` command to add changes to file `X` to the commit,
77+
or `git add .` to add all the changed files.
6878

6979
9. Run the command:
7080
```
@@ -76,14 +86,19 @@ How to make changes
7686
```
7787
git push
7888
```
79-
11. Go to your fork on Github at `https://github.com/USER_NAME/agda-stdlib` and click the green `Compare & pull request` button to open a pull request.
8089

81-
12. The standard library maintainers will then be made aware of your requested changes and should be in touch soon.
90+
11. Go to your fork on Github at `https://github.com/USER_NAME/agda-stdlib`
91+
and follow the [official Git instructions](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork)
92+
to open a pull request to the main standard library repository.
93+
94+
12. The library maintainers will then be made aware of your requested
95+
changes and should be in touch soon.
8296

8397
Installing `fix-agda-whitespace`
8498
--------------------------------
8599

86-
This tool is kept in the main agda repository. It can be installed by following these instructions:
100+
This tool is kept in the main agda repository. It can be installed by
101+
following these instructions:
87102
```
88103
git clone https://github.com/agda/agda
89104
cd agda/src/fix-agda-whitespace

0 commit comments

Comments
 (0)