|
5 | 5 | [![Documentation Status][rtd-badge]][rtd-link] |
6 | 6 | [![Code style: black][black-badge]][black-link] |
7 | 7 |
|
| 8 | +We welcome all contributions! |
| 9 | +See the [EBP Contributing Guide](https://executablebooks.org/en/latest/contributing.html) for general details, and below for guidance specific to MyST-Parser. |
| 10 | + |
8 | 11 | ## Install for development |
9 | 12 |
|
10 | 13 | To install `myst-parser` for development, take the following steps: |
@@ -65,21 +68,6 @@ For documentation build tests: |
65 | 68 | {ref}`develop/testing` |
66 | 69 | ``` |
67 | 70 |
|
68 | | -## Pull Requests |
69 | | - |
70 | | -To contribute, make Pull Requests to the `master` branch (this is the default branch). A PR can consist of one or multiple commits. Before you open a PR, make sure to clean up your commit history and create the commits that you think best divide up the total work as outlined above (use `git rebase` and `git commit --amend`). Ensure all commit messages clearly summarise the changes in the header and the problem that this commit is solving in the body. |
71 | | - |
72 | | -Merging pull requests: There are three ways of 'merging' pull requests on GitHub: |
73 | | - |
74 | | -- Squash and merge: take all commits, squash them into a single one and put it on top of the base branch. |
75 | | - Choose this for pull requests that address a single issue and are well represented by a single commit. |
76 | | - Make sure to clean the commit message (title & body) |
77 | | -- Rebase and merge: take all commits and 'recreate' them on top of the base branch. All commits will be recreated with new hashes. |
78 | | - Choose this for pull requests that require more than a single commit. |
79 | | - Examples: PRs that contain multiple commits with individually significant changes; PRs that have commits from different authors (squashing commits would remove attribution) |
80 | | -- Merge with merge commit: put all commits as they are on the base branch, with a merge commit on top |
81 | | - Choose for collaborative PRs with many commits. Here, the merge commit provides actual benefits. |
82 | | - |
83 | 71 | [github-ci]: https://github.com/executablebooks/MyST-Parser/workflows/continuous-integration/badge.svg?branch=master |
84 | 72 | [github-link]: https://github.com/executablebooks/MyST-Parser |
85 | 73 | [codecov-badge]: https://codecov.io/gh/executablebooks/MyST-Parser/branch/master/graph/badge.svg |
|
0 commit comments