Guidelines:ContributorWorkflow - Revision history

Dominic: /* Rebasing Story Branches */

2025-10-24T07:11:22Z

Rebasing Story Branches

← Older revision		Revision as of 07:11, 24 October 2025
Line 83:		Line 83:
	=== Rebasing Story Branches ===		=== Rebasing Story Branches ===

	While you ~~are~~ working on your story branch, the upstream <code>dev</code> branch may have progressed with commits from other people. Therefore, it will become necessary that you occasionally rebase your <code>story</code> branch on the latest version of the upstream <code>dev</code> branch.		While you were working on your story branch, the upstream <code>dev</code> branch may have progressed with commits from other people. Therefore, it will become necessary that you occasionally rebase your <code>story</code> branch on the latest version of the upstream <code>dev</code> branch.

	To do so, first update your local <code>dev</code> branch:		To do so, first update your local <code>dev</code> branch:

Dominic: /* Adding the Development Branch */

2025-10-24T07:10:21Z

Adding the Development Branch

← Older revision		Revision as of 07:10, 24 October 2025
Line 52:		Line 52:
	git pull upstream dev		git pull upstream dev

	This adds a copy of the Sahana Eden <code>dev</code> branch to your local clone, and checks out the latest developer version of the code (which is usually a number of commits ahead of the stable version).		This adds a copy of the Sahana Eden <code>dev</code> branch to your local clone, and checks out the latest developer version of the code (which is usually a number of commits ahead of the stable version):

	~~Now your local clone has two branches, like this:~~
	[[File:Clone with dev branch.png\|frame\|center]]		[[File:Clone with dev branch.png\|frame\|center]]

Dominic: /* Creating a Local Clone */

2025-10-24T07:09:44Z

Creating a Local Clone

← Older revision		Revision as of 07:09, 24 October 2025
Line 27:		Line 27:
	=== Creating a Local Clone ===		=== Creating a Local Clone ===

	Follow the steps in the [https://eden-asp.readthedocs.io/en/latest/dev/setup.html '''Developer Handbook'''] to set up a local instance of Sahana Eden.		Follow the steps in the [https://eden-asp.readthedocs.io/en/latest/dev/setup.html '''Developer Handbook'''] to set up a local instance of Sahana Eden. You will use this local instance to test-run and verify your changes.

	When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone '''your own fork''':		When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone '''your own fork''':
Line 33:		Line 33:
	<nowiki>git clone --recursive https://github.com/[yourname]/eden.git ~/eden</nowiki>		<nowiki>git clone --recursive https://github.com/[yourname]/eden.git ~/eden</nowiki>

	...instead of ''sahana/eden''.		...instead of ''sahana/eden.git''.

	Finally, configure ''sahana/eden'' as upstream repository for your clone:		Finally, configure ''sahana/eden.git'' as upstream repository for your clone:

	<nowiki>git remote add upstream https://github.com/sahana/eden.git</nowiki>		<nowiki>git remote add upstream https://github.com/sahana/eden.git</nowiki>

	~~Now you can use this local instance to test-run and verify your changes.~~

	=== Adding the Development Branch ===		=== Adding the Development Branch ===

Dominic: /* Creating a Local Clone */

2025-10-24T07:08:14Z

Creating a Local Clone

← Older revision		Revision as of 07:08, 24 October 2025
Line 31:		Line 31:
	When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone '''your own fork''':		When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone '''your own fork''':

	git clone --recursive https://github.com/[yourname]/eden.git ~/eden		<nowiki>git clone --recursive https://github.com/[yourname]/eden.git ~/eden</nowiki>

	...instead of ''sahana/eden''.		...instead of ''sahana/eden''.
Line 37:		Line 37:
	Finally, configure ''sahana/eden'' as upstream repository for your clone:		Finally, configure ''sahana/eden'' as upstream repository for your clone:

	git remote add upstream https://github.com/sahana/eden.git		<nowiki>git remote add upstream https://github.com/sahana/eden.git</nowiki>

	Now you can use this local instance to test-run and verify your changes.		Now you can use this local instance to test-run and verify your changes.

Dominic: /* Prerequisites */

2025-10-24T07:06:31Z

Prerequisites

← Older revision		Revision as of 07:06, 24 October 2025
Line 9:		Line 9:
	=== Prerequisites ===		=== Prerequisites ===

	~~Additionally, you will need~~:		You should have the following installed on your computer:

	* [https://git-scm.com '''git''']		* [https://git-scm.com '''git''']

Dominic: /* Submitting Pull Requests */

2025-10-24T07:04:25Z

Submitting Pull Requests

← Older revision		Revision as of 07:04, 24 October 2025
Line 149:		Line 149:
	You can also discard your story branch:		You can also discard your story branch:

	git branch -d ~~story_branch~~		git branch -d story
	git push -d origin ~~story_branch~~		git push -d origin story

	Now, your local clone has two branches again - with your commits from the <code>story</code> branch merged into the <code>dev</code> branch:		Now, your local clone has two branches again - with your commits from the <code>story</code> branch merged into the <code>dev</code> branch:

Dominic: /* Adding the Development Branch */

2025-10-23T18:56:42Z

Adding the Development Branch

← Older revision		Revision as of 18:56, 23 October 2025
Line 54:		Line 54:
	git pull upstream dev		git pull upstream dev

	This adds a copy of the Sahana Eden <code>dev</code> branch to your local clone, and checks out the latest developer version of the code.		This adds a copy of the Sahana Eden <code>dev</code> branch to your local clone, and checks out the latest developer version of the code (which is usually a number of commits ahead of the stable version).

	Now your local clone has two branches, like this:		Now your local clone has two branches, like this:

Dominic: /* Creating a Local Clone */

2025-10-23T18:55:23Z

Creating a Local Clone

← Older revision		Revision as of 18:55, 23 October 2025
Line 29:		Line 29:
	Follow the steps in the [https://eden-asp.readthedocs.io/en/latest/dev/setup.html '''Developer Handbook'''] to set up a local instance of Sahana Eden.		Follow the steps in the [https://eden-asp.readthedocs.io/en/latest/dev/setup.html '''Developer Handbook'''] to set up a local instance of Sahana Eden.

	When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone your own fork:		When you get to [https://eden-asp.readthedocs.io/en/latest/dev/setup.html#installing-eden '''Installing Eden'''], make sure to clone '''your own fork''':

	git clone --recursive https://github.com/[yourname]/eden.git ~/eden		git clone --recursive https://github.com/[yourname]/eden.git ~/eden

Dominic: /* Submitting Pull Requests */

2025-10-23T18:54:38Z

Submitting Pull Requests

← Older revision		Revision as of 18:54, 23 October 2025
Line 140:		Line 140:
	git push origin story		git push origin story

	Eventually, the maintainer will decide whether to accept and merge your changes, or to reject them.		Eventually, the maintainer will decide whether to accept and '''merge''' your changes, or to reject them.

	Once your changes have been merged successfully into the sahana/eden <code>dev</code> branch, you can update your local copy of it:		Once your changes have been merged successfully into the sahana/eden <code>dev</code> branch, you can update your local copy of it:

Dominic: /* Submitting Pull Requests */

2025-10-23T18:54:11Z

Submitting Pull Requests

← Older revision		Revision as of 18:54, 23 October 2025
Line 132:		Line 132:
	* against the <code>dev</code> branch in the sahana/eden repository ('''base''' repository)		* against the <code>dev</code> branch in the sahana/eden repository ('''base''' repository)

	Anyone can comment on your pull request, and you can discuss their feedback with them directly on GitHub. However, before your changes can be merged into the upstream repository, they will have to pass a formal review by a maintainer of that repository.		Anyone can comment on your pull request, and you can discuss their feedback with them directly on GitHub. However, before your changes can be merged into the upstream repository, they will have to pass a formal '''review''' by a maintainer of that repository.

	There may be issues to be resolved, or details to be improved upon. If you thus need to modify your pull request again in order to pass the review, make the modifications locally, commit them to your <code>story</code> branch, and then simply push again to update your pull request:		There may be issues to be resolved, or details to be improved upon. If you thus need to modify your pull request again in order to pass the review, make the modifications locally, commit them to your <code>story</code> branch, and then simply push again to update your pull request: