Updated Developer Hub's Source Code Managment

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
Kunda1
Posts: 612
Joined: Thu Jan 05, 2017 9:03 pm

Updated Developer Hub's Source Code Managment

Postby Kunda1 » Mon Feb 06, 2017 10:15 am

https://www.freecadweb.org/wiki/index.p ... ent#Access
Here is the diff: https://www.freecadweb.org/wiki/index.p ... did=182842

Changed the orientation from SF to GitHub
Tried to add some git commands to make it more friendly to amateur devs (but the wiki markup wasn't flexible to make it cosmetically sufficient)
Fixed some grammar issues
Added hyperlinks

The rest of the page needs to be reworked so that SF is shown as deprecated. Please advise.
jean.thil
Posts: 156
Joined: Tue Jul 28, 2015 7:28 am

Re: Updated Developer Hub's Source Code Managment

Postby jean.thil » Mon Feb 06, 2017 2:34 pm

May I suggest that you add the git command needed for the actions ?

Create a new branch ---> example command
Checkout that new branch ---> example command
Commit your changes to that new branch ---> example command
Push that new branch to your GitHub repo ---> example command

I think that one must also add an origin to its git repository in order to track the changes on master ---> example command
After that, the user will need to do merges between master and its branch ---> example command
User avatar
Kunda1
Posts: 612
Joined: Thu Jan 05, 2017 9:03 pm

Re: Updated Developer Hub's Source Code Managment

Postby Kunda1 » Mon Feb 06, 2017 2:55 pm

jean.thil wrote:May I suggest that you add the git command needed for the actions ?

Create a new branch ---> example command
Checkout that new branch ---> example command
Commit your changes to that new branch ---> example command
Push that new branch to your GitHub repo ---> example command

I think that one must also add an origin to its git repository in order to track the changes on master ---> example command
After that, the user will need to do merges between master and its branch ---> example command

Sounds good to me. Please feel free to add them. I don't know CLI git very well, since i've been using a git GUI
User avatar
kkremitzki
Posts: 316
Joined: Thu Mar 03, 2016 9:52 pm
Location: Texas

Re: Updated Developer Hub's Source Code Managment

Postby kkremitzki » Mon Feb 06, 2017 4:42 pm

Good pick for a page to revise, that was quite out of date. I cleaned it up some more, and I can add more in-depth git commands in a bit.
User avatar
Kunda1
Posts: 612
Joined: Thu Jan 05, 2017 9:03 pm

Re: Updated Developer Hub's Source Code Managment

Postby Kunda1 » Mon Feb 06, 2017 5:02 pm

kkremitzki wrote:Good pick for a page to revise, that was quite out of date. I cleaned it up some more, and I can add more in-depth git commands in a bit.

Thanks! and nice work @kkremitzki :)
User avatar
kkremitzki
Posts: 316
Joined: Thu Mar 03, 2016 9:52 pm
Location: Texas

Re: Updated Developer Hub's Source Code Managment

Postby kkremitzki » Mon Feb 06, 2017 5:07 pm

This section can probably be deleted but I'd like confirmation from someone who actually knows it's no longer relevant.
jean.thil
Posts: 156
Joined: Tue Jul 28, 2015 7:28 am

Re: Updated Developer Hub's Source Code Managment

Postby jean.thil » Mon Feb 06, 2017 7:29 pm

Sounds good to me. Please feel free to add them. I don't know CLI git very well, since i've been using a git GUI

Sorry, but if I suggested to add them it is because I don't know very well how to do that.
I think that for the firsts commands it should be :
Create a new branch ---> git branch my_branch
Checkout that new branch ---> git checkout my_branch
Commit your changes to that new branch ---> git add modified_file1 modified_file2
git commit -m 'what I have done'

Push that new branch to your GitHub repo---> git push
but I haven't done add an origin to its git repository in order to track the changes on master nor any merge.
User avatar
yorik
Site Admin
Posts: 8543
Joined: Tue Feb 17, 2009 9:16 pm
Location: São Paulo, Brazil
Contact:

Re: Updated Developer Hub's Source Code Managment

Postby yorik » Tue Feb 07, 2017 12:17 pm

kkremitzki wrote:This section can probably be deleted but I'd like confirmation from someone who actually knows it's no longer relevant.

Yes. I think it can be deleted. That was the policy we had on SVN, but with git it's not necessary to give write permission to everybody anymore...