Skip to content

Commit 568e89f

Browse files
committed
CONTRIBUTING.md: describe general workflow
1 parent 947e585 commit 568e89f

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,27 @@ _TBD_ (see [issue #4] for discussion)
44

55
### General Workflow
66

7-
_TODO: write me_
7+
1. [Fork the repository](https://github.com/idris-hackers/software-foundations/fork) if you haven't already.
8+
1. Check the [open pull requests](https://github.com/idris-hackers/software-foundations/pulls) for any related work in progress (WIP).
9+
1. Check out a new branch based on `develop`.
10+
1. Push some commits to your fork.
11+
- The general workflow here is as follows:
12+
- Copy/paste the original text, [reformatting](#formatting) as
13+
appropriate.
14+
- Translate Coq code into (idiomatic) Idris.
15+
- Edit, augment and delete text as appropriate.
16+
_N.B. This can be done in subsequent pull requests._
17+
1. Open a pull request (as soon as possible).
18+
- If it's not ready to be merged, but you want to _claim_ a particular task,
19+
prefix the pull request with `WIP:`.
20+
- Make a comment and remove the `WIP:` when it's ready to be reviewed and
21+
merged. _Remember: formatting the text and taking a first pass at
22+
translating the Coq to Idris is enough for an initial pull request._
23+
1. Open subsequent pull requests following a similar pattern for and edits or
24+
other updates
25+
26+
The `develop` branch is the _working branch_ and `master` is for _releases_,
27+
i.e. rebuilt [PDF]s and [website](https://idris-hackers.github.io/software-foundations) updates.
828

929

1030
### Formatting

0 commit comments

Comments
 (0)