diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8d3bcc01..2d59be9b 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,5 +1,5 @@ -Contributing to Infix -===================== +Contributing Guidelines +======================= Thank :heart: you for taking the time to read this! @@ -12,6 +12,7 @@ If you are unsure how to start implementing an idea or fix: - :bug: open an issue, there are human friendly templates for _bugs_ and _feature requests_ at - :speech_balloon: use the [Q&A Forum][discuss] + - :technologist: The [Developer's Guide][devguide] is also a useful start > _Talking about code and problems first is often the best way to get > started before submitting a pull request. We have found it always diff --git a/doc/developers-guide.md b/doc/developers-guide.md index d90d88ea..5a54d839 100644 --- a/doc/developers-guide.md +++ b/doc/developers-guide.md @@ -206,20 +206,18 @@ corresponding image for execution with our normal tooling: Contributing ------------ -Infix is built from many parts, when contributing you need to set up -your own fork, create a local branch for your change, push to your fork, -and then use GitHub to create a *Pull Reqeuest*. +Infix is built from many components, when contributing you need to set +up your own fork, create a local branch for your change, push to your +fork, and then use GitHub to create a *Pull Reqeuest*. -For this to work as painlessly as possible: +For this to work as *painlessly as possible* for everyone involved: - 1. Fork Infix to your own user or organization[^1] - 2. Fork all the Infix submodules, e.g., `kernelkit/buildroot` to your - own user or organization as well - 3. Clone your fork of Infix to your laptop/workstation - -If you use a GitHub organization you get the added benefit of having -local peer reviews of changes before making a pull request to the -upstream Infix repository. + 1. Fork Infix to your own user or organization[^1] + 2. Fork all the Infix submodules, e.g., `kernelkit/buildroot` to your + own user or organization as well + 3. Clone your fork of Infix to your laptop/workstation + 4. [Deactivate the Actions][6] you don't want in your fork + 5. Please read the [Contributing Guidelines][5] as well! ```bash $ cd ~/Projects @@ -227,10 +225,10 @@ $ git clone https://github.com/YOUR_USER_NAME/infix.git $ cd infix/ $ git submodule update --init ``` - > **Note:** when updating/synchronizing with upstream Infix changes you > may have to synchronize your forks as well. GitHub have a `Sync fork` -> button in the GUI for your fork for this purpose. +> button in the GUI for your fork for this purpose. A cronjob on your +> server of choice can do this for you with the [GitHub CLI tool][7]. [^1]: Organizations should make sure to lock the `main` (or `master`) branch of their clones to ensure members do not accidentally merge @@ -243,3 +241,6 @@ $ git submodule update --init [2]: https://github.com/wkz/qeneth [3]: https://netopeer.liberouter.org/doc/sysrepo/master/html/dev_guide.html [4]: https://buildroot.org/downloads/manual/manual.html#_developer_guide +[5]: https://github.com/kernelkit/infix/blob/main/.github/CONTRIBUTING.md +[6]: https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow +[7]: https://cli.github.com/