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

Document how to update a "develop branch to develop branch" pull request #10261

Conversation

martinAmouzou
Copy link
Contributor

@martinAmouzou martinAmouzou commented Jan 24, 2024

What this PR does / why we need it: This PR is to solve the issue 9508 on how to "update a develop branch to develop branch" pull request

Which issue(s) this PR closes:

Special notes for your reviewer:

Suggestions on how to test this: The modifications are on the latest section of the doc (version-control.rst)

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Is there a release notes update needed for this change?: No

Additional documentation:

Preview at https://dataverse-guide--10261.org.readthedocs.build/en/10261/developers/version-control.html#handing-a-pull-request-from-a-develop-branch

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

Just a quick pass... thanks for the pull request! ❤️

@@ -287,4 +287,8 @@ GitHub documents how to make changes to a fork at https://help.github.com/articl

----

Develop branch and pull request
--------------------------------------------
Please do not use your forked develop branch to push a PR and follow the `1st scenario: preparing the first pull request of Version Control Guide <https://github.com/Recherche-Data-Gouv/dataverse/blob/develop/doc/sphinx-guides/source/developers/version-control.rst>`_.
Copy link
Member

Choose a reason for hiding this comment

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

I'm confused by this link. We're already in version-control.rst. Why would we link to the file we are already in? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I redirected to the section on git commands. I just corrected the link.

Copy link
Member

Choose a reason for hiding this comment

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

@martinAmouzou ah, thanks, I understand now and that # thing is a good sphinx/rst trick!

Is it ok if I move what you wrote somewhere else? And add a bit more content (for maintainers like me)?

Copy link
Contributor

Choose a reason for hiding this comment

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

Please, feel free to do so ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pdurbin Yeah, you can do so. thanks

Copy link
Member

Choose a reason for hiding this comment

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

Great, thanks!

@pdurbin pdurbin added the Size: 0.5 A percentage of a sprint. 0.35 hours label Feb 28, 2024
@pdurbin pdurbin changed the title 9508 update develop branch to develop branch pull request Document how to update a "develop branch to develop branch" pull request Mar 26, 2024
@luddaniel
Copy link
Contributor

@pdurbin Should we merge this to closes #9508 ? Or do you have another idea ?

@pdurbin
Copy link
Member

pdurbin commented Sep 19, 2024

@luddaniel yes! I made a note to myself to look at this soon.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

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

@martinAmouzou I wrote what I had in mind and will go ahead and merge this. Thanks!

@pdurbin pdurbin merged commit 9a1e494 into IQSS:develop Sep 20, 2024
2 of 3 checks passed
@pdurbin pdurbin added this to the 6.4 milestone Sep 20, 2024
@luddaniel luddaniel deleted the 9508-update-develop-branch-to-develop-branch-pull-request branch September 23, 2024 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 0.5 A percentage of a sprint. 0.35 hours
Projects
Status: Done 🧹
Status: Done
Development

Successfully merging this pull request may close these issues.

Document how to update a "develop branch to develop branch" pull request
3 participants