| # Contributing |
| Contributions are welcome and encouraged! |
|
|
| The process: Please fork the repository and submit a pull request. Ensure that the pull request passes the CI script. |
|
|
| Ensure that your fork is **rebased**. This is important. Pull requests with merge conflicts will very likely be rejected on principle. |
|
|
| ## How to rebase |
| Ensure that your local git clone's `origin` remote is *your own fork*: |
| ```sh |
| git remote set-url origin https://github.com/<you>/DFFRAM |
| ``` |
|
|
| Ensure that your local git clone also has an `upstream` remote. You can add it via the command: |
| ```sh |
| git remote get-url upstream |
| > fatal: No such remote 'upstream' |
| git remote add upstream https://github.com/AUCOHL/DFFRAM` |
| ``` |
|
|
| You can start a rebase by typing: |
| ```sh |
| git fetch upstream |
| git rebase upstream/main |
| ``` |
|
|
| If there are no conflicts, you will not get any error messages. However, in the event you do: `git diff --name-only --diff-filter=U` will list the conflicts. Resolve all of your conflicts properly, then invoke the following: |
| ```sh |
| git add . |
| git rebase --continue |
| ``` |
|
|
| Repeat the previous step until you get no error messages. Then finally, you need to rewrite your fork's history as follows: |
|
|
| ```sh |
| git push -fu origin main |
| ``` |
|
|
| Then, create your pull request. If all went well, the CI should pass. |
|
|
| ## Note to maintainers |
|
|
| If the number of commits is low, rebase and merge, but if it is high (5 commits or more), squash and merge. |
|
|
| Squash and merge makes for a cleaner commit history, but will require pretty much everyone to rebase any work they've had off the main branch with a great degree more difficulty. |
|
|
