MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
135 stars 124 forks source link

Add keeping fork up to date section in DG #2453

Closed itsyme closed 6 months ago

itsyme commented 6 months ago

What is the purpose of this pull request?

Overview of changes: Creates a new sub-section in the Workflow page of the developer guide about the recommended way to keep contributor's forks up to date with the main repo. I felt this was important as there are shortcuts like the 'Update branch' button in PRs that may be used by newer contributors who may not fully understand what happens under the hood. Keeping the fork in sync with the main repo would be a clean and straightforward way to keep the feature branches up to date.

Anything you'd like to highlight/discuss: Open for discussion :)

Testing instructions:

Proposed commit message: (wrap lines at 72 characters) Add keeping your fork up to date section in DG


Checklist: :ballot_box_with_check:


Reviewer checklist:

Indicate the SEMVER impact of the PR:

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).
codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 48.90%. Comparing base (8a5688f) to head (712bdb0).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2453 +/- ## ======================================= Coverage 48.90% 48.90% ======================================= Files 124 124 Lines 5247 5247 Branches 1112 1112 ======================================= Hits 2566 2566 Misses 2373 2373 Partials 308 308 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

itsyme commented 6 months ago

I have added merge on top of just rebase for contributors to choose what they prefer