You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-3Lines changed: 19 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,25 @@ While we encourage all contributions, remember that Adamant is used everyday to
8
8
9
9
## Creating a Submission
10
10
11
-
Adamant follows the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) development process. You should begin by [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository. When you have finished making changes on your fork, create a pull request back to this repository.
11
+
Adamant follows the [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow) development process. You should begin by [forking](https://docs.github.com/en/get-started/quickstart/fork-a-repo) this repository. When you have finished making changes on your fork, create a [pull request](https://github.com/lasp/adamant/pulls) back to this repository.
12
12
13
-
Please try to keep submissions small and focused on single fixes, enhancements, or additions. This makes changes easier to review and faster to merge.
13
+
### Pull Request
14
14
15
-
Once a pull request has been submitted the following will occur:
15
+
Please adhere to the following when submitting a pull request:
16
+
17
+
- Pull requests should be made against `main`.
18
+
- Keep submissions small and focused on single fixes, enhancements, or additions. This makes changes easier to review and faster to merge.
19
+
- Include a summary of changes that gives reviewers an idea of what they should pay attention to.
20
+
- Pull request branches should have as "clean" of a history as possible.
21
+
- Each commit should present one change or idea to a reviewer.
22
+
- Commits that merely "fix up" previous commits should be interactively rebased and squashed into their targets.
23
+
- Prefer the use of `git rebase`.
24
+
1.`git rebase` actually _rebases_ your branch from the current main branch's endpoint. This localizes conflicts to the commits at which they actually appear, though it can become complicated when there are more than a few conflicts.
25
+
2.`git merge` pulls in all the updates that your branch does not have, and combines them with the updates you have made in a single merge commit. This allows you to deal with any and all conflicts at once, but information such as when conflicts originated is lost.
26
+
27
+
For more info on `git merge` vs `git rebase` see [here](https://www.atlassian.com/git/tutorials/merging-vs-rebasing).
28
+
29
+
Once a pull request has been submitted, a maintainer will review your submission.
16
30
17
31
### Submission Review
18
32
@@ -28,6 +42,8 @@ Note that many of these checks are annoyingly pedantic, but this helps ensure un
28
42
29
43
Once the pull request is passing all tests and checks and has been approved by a maintainer it will be merged into the Adamant repository!
30
44
45
+
Pull requests should be merged by a maintainer using the "create a merge commit" strategy. In combination with the pull request recommendations above, this ensures that features are neatly bracketed by merge commits on either side, making a clear hierarchical separation between features added to main and the work that went into each feature.
46
+
31
47
## Contribution Ownership
32
48
33
49
Contributions to Adamant will abide by the [GitHub Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service#6-contributions-under-repository-license) which states:
0 commit comments