Getting started as a developer: Difference between revisions
From FreeMind
Jump to navigationJump to search
| Line 30: | Line 30: | ||
=== Compile, Branch and Patch === | === Compile, Branch and Patch === | ||
<code bash> | * get the latest code <code bash>git clone git://freemind.git.sourceforge.net/gitroot/freemind/freemind</code> | ||
* <code bash>cd freemind/freemind</code> | |||
* start FreeMind <code bash>ant run</code> | |||
git clone git://freemind.git.sourceforge.net/gitroot/freemind/freemind | * create branch "new_feature" <code bash>git checkout -b new_feature</code> | ||
* ... change the code ... | |||
cd freemind/freemind | * commit changes <code bash>git commit -a</code> | ||
* ... change again ... | |||
* commit again <code bash>git commit -a</code> | |||
* create patch file <code bash>git format-patch master --stdout > patch_by_''username''_for_feature_''xyz''.txt</code> | |||
ant run | |||
git checkout -b new_feature | |||
git commit -a | |||
git commit -a | |||
git format-patch master --stdout > | |||
</code> | |||
(on Mac use <code bash>ant runmac</code> to run FreeMind). | (on Mac use <code bash>ant runmac</code> to run FreeMind). | ||
Revision as of 14:41, 7 August 2011
Getting started as a developer
Contributing to FreeMind as a developer
A new developer starts in two stages.
- Patches. At firsts, she sends her contributions as patches into Patches tracker.
- GIT. Later, after she has shown some volume of contribution, she gets access to GIT repository.
Detail: If you are considering becoming a new developer, please proceed as follows.
- Create a user account at SourceForge.
- Discuss your contribution (the change, feature, bug fix, documentation or test plan) in our open discussion forum.
- If the topic is accepted, start to change the up-to-date code that you have downloaded from GIT. Beware of using the right GIT branch:
- Currently, there is no GIT branch.
- If, during implementing the feature, you have any questions, feel free to ask them in the "Open Discussion" forum. It is read by the other developers who possible can help you.
- Post your contribution in the patch section of SourceForge or send it by email to the current project manager. We do not respond immediately, as FreeMind team consists of volunteers.
- After having successfully developed and integrated some items, you get access to FreeMind's GIT repository at SourceForge.
Getting the latest beta version of FreeMind from GIT
A beta version you can get from the GIT, searching there for the latest branch, or the branch of your choice. Please note that beta versions are unstable and may contain serious bugs. Please, use beta versions only if:
- you urgently need a feature included in the version, and you are willing to backup your work often, or
- you want to give FreeMind developers feedback on the beta versions, which is highly appreciated.
To get a beta version from GIT, see the guides at GIT section.
Compiling last stable version of FreeMind
See Building.
Compile, Branch and Patch
- get the latest code
git clone git://freemind.git.sourceforge.net/gitroot/freemind/freemind cd freemind/freemind- start FreeMind
ant run - create branch "new_feature"
git checkout -b new_feature - ... change the code ...
- commit changes
git commit -a - ... change again ...
- commit again
git commit -a - create patch file
git format-patch master --stdout > patch_by_username_for_feature_xyz.txt
(on Mac use ant runmac to run FreeMind).
See also
- FreeMind Actions
- Plugins
- Undoable Actions (first version available)
