Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

contributing: Add branching how-to #2963

Open
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

wenzeslaus
Copy link
Member

@wenzeslaus wenzeslaus commented May 17, 2023

A document on how to create a new branch and what needs to be done around that. This complements the release how-to which is about creating releases (tags).

@neteler neteler added the manual Documentation related issues label May 17, 2023
@wenzeslaus wenzeslaus added this to the 8.4.0 milestone May 17, 2023
wenzeslaus and others added 2 commits May 18, 2023 20:42
Co-authored-by: Veronica Andreo <[email protected]>
@wenzeslaus
Copy link
Member Author

The commit cab12f1 does not add what it says it adds. The syntax fix is needed, but the information should go to:

## Website Updates

(Here go things like addition of branch creation to history.)

@echoix
Copy link
Member

echoix commented Feb 8, 2024

The commit cab12f1 does not add what it says it adds. The syntax fix is needed, but the information should go to:


## Website Updates



(Here go things like addition of branch creation to history.)

We could just clean up the squash message instead of rebasing to achieve the same end goal.

That needed change is in a comment suggestion by Markus Neteler, it just needs to be committed. After that, the PR should be ready.

Having docs is better than no docs, and it's a snapshot of the (then) current knowledge of the workflow. If we find better ways in the future, it can be updated to follow along.

Docs should be fast to merge, especially non end-user addressed ones like this one.

@echoix
Copy link
Member

echoix commented Feb 8, 2024

Do you allow me to finish these two things up and merge?

@wenzeslaus
Copy link
Member Author

A fresh pair of eyes here would be great @echoix!

Copy link
Member

@echoix echoix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wrote some comments weeks ago but stayed "pending" since I must have stopped before sending them

doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Show resolved Hide resolved
@github-actions github-actions bot added the docs label Mar 12, 2024
@wenzeslaus wenzeslaus modified the milestones: 8.4.0, 8.5.0 Jun 10, 2024
@wenzeslaus wenzeslaus marked this pull request as ready for review June 10, 2024 21:02
@wenzeslaus
Copy link
Member Author

This is now ready for review. Some information might be missing, but we may have a complete picture only after 8.4.0RC1 or even 8.4.0.

doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
@wenzeslaus
Copy link
Member Author

This is now ready to be merged. Please, review.

@echoix
Copy link
Member

echoix commented Jun 11, 2024

@veroandreo do you see more typos other than the ones I quickly spotted?

doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
doc/development/branching_how-to.md Outdated Show resolved Hide resolved
@neteler
Copy link
Member

neteler commented Jun 19, 2024

Browsing this on phone (hence limited overview for me), I'd appreciate a hint in the text concerning the cronjob version bump which is needed, too.

The binary build cronjobs are currently failing.

@neteler
Copy link
Member

neteler commented Jun 19, 2024

And one more (to be done by @landam):

  • wingrass.fsv.cvut.cz/grassXX/addons/ also needs to be updated accordingly.

@echoix
Copy link
Member

echoix commented Sep 3, 2024

And one more (to be done by @landam):

  • wingrass.fsv.cvut.cz/grassXX/addons/ also needs to be updated accordingly.

There's missing this, but aren't we better to have the currents docs than no updated docs at all (waiting for more than three months for that last edit, if ever we get to it).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs manual Documentation related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants