Branches in Emacs Git repo

Branches in Emacs Git repo

[Marcin Borkowski]

Hi,

since I'm planning to start contributing to Emacs, and I don't want to
break something, I'd like to learn which branches are exactly for what
and what should I do (assuming I will get write access at some point) -
for instance, should I create small branches for my patches?  Should
they be branched from master?

Is there any document explaining this things?  If not, I'd be happy to
write one (once I know that myself).

Best,

-- 
Marcin Borkowski
http://octd.wmi.amu.edu.pl/en/Marcin_Borkowski
Faculty of Mathematics and Computer Science
Adam Mickiewicz University

Re: Branches in Emacs Git repo

[Jorge Alberto Garcia]

[-- Attachment #1: Type: text/plain, Size: 1215 bytes --]

On Fri, Mar 18, 2016 at 11:24 AM, Marcin Borkowski <mbork@mbork.pl> wrote:

> Hi,
>
> since I'm planning to start contributing to Emacs, and I don't want to
> break something, I'd like to learn which branches are exactly for what
> and what should I do (assuming I will get write access at some point) -
> for instance, should I create small branches for my patches?  Should
> they be branched from master?
>
>
I think right now almost all new features and bug fixed are using branch
emacs-25, AFAIK once  emacs-25 is considered stable enough it is merged
with
master branch.



> Is there any document explaining this things?  If not, I'd be happy to
> write one (once I know that myself).
>
> Best,
>

some time ago Nicolas Petton send a url for a new website for emacs
may be he added some info about this. Meanwhile I suggest you to take a
look
at the mailing list archive to see how it went for others.

http://nicolas-petton.fr/ressources/emacs-website/

I myself struggled with this same situation where there is not an easy
intro for
new developers.



>
> --
> Marcin Borkowski
> http://octd.wmi.amu.edu.pl/en/Marcin_Borkowski
> Faculty of Mathematics and Computer Science
> Adam Mickiewicz University
>
>

[-- Attachment #2: Type: text/html, Size: 2434 bytes --]

Re: Branches in Emacs Git repo

[John Wiegley]

>>>>> Jorge Alberto Garcia <jorge.garcia.gonzalez@gmail.com> writes:

> I think right now almost all new features and bug fixed are using branch
> emacs-25

Hi Jorge,

New features go to master currently, and "safe" bug fixes to emacs-25.

-- 
John Wiegley                  GPG fingerprint = 4710 CF98 AF9B 327B B80F
http://newartisans.com                          60E1 46C4 BD1A 7AC1 4BA2

Re: Branches in Emacs Git repo

[Eli Zaretskii]

> From: Marcin Borkowski <mbork@mbork.pl>
> Date: Fri, 18 Mar 2016 18:24:07 +0100
> 
> since I'm planning to start contributing to Emacs, and I don't want to
> break something, I'd like to learn which branches are exactly for what
> and what should I do (assuming I will get write access at some point) -
> for instance, should I create small branches for my patches?  Should
> they be branched from master?

There are only 2 branches -- master and emacs-25.

> Is there any document explaining this things?

CONTRIBUTE explains this.

Re: Branches in Emacs Git repo

[Michael Heerdegen]

Marcin Borkowski <mbork@mbork.pl> writes:

> Hi,
>
> since I'm planning to start contributing to Emacs, and I don't want to
> break something, I'd like to learn which branches are exactly for what
> and what should I do (assuming I will get write access at some point)
> - for instance, should I create small branches for my patches?

Don't be too frightened.  Any patch can introduce breakage if unexpected
things happen.  It happens to regular contributers too.  Of course you
should be careful, but don't thwart yourself, I think you are totally
able to rate your work.

If it helps, you can post a commit on emacs-devel before pushing for
review.  I did that a while ago to be sure that I respected all commit
message rules.


Regards,

Michael.

Re: Branches in Emacs Git repo

[Xue Fuqiao]

On Sat, Mar 19, 2016 at 1:24 AM, Marcin Borkowski <mbork@mbork.pl> wrote:
> Hi,

Hi Marcin,

> since I'm planning to start contributing to Emacs, and I don't want to
> break something, I'd like to learn which branches are exactly for what
> and what should I do (assuming I will get write access at some point) -
> for instance, should I create small branches for my patches?  Should
> they be branched from master?
>
> Is there any document explaining this things?  If not, I'd be happy to
> write one (once I know that myself).

See CONTRIBUTE:
http://git.savannah.gnu.org/cgit/emacs.git/plain/CONTRIBUTE

For the release process and info about branches in Emacs, see
admin/release-process:
http://git.savannah.gnu.org/cgit/emacs.git/plain/admin/release-process

For ELPA-related information, see
http://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README

If the information in these documents are not clear, you're welcome to
give us suggestions.

Thanks for wanting to contribute, welcome, and do not hesitate to ask
any further question, we are here to help!

Re: Branches in Emacs Git repo

[Phillip Lord]

Marcin Borkowski <mbork@mbork.pl> writes:
> since I'm planning to start contributing to Emacs, and I don't want to
> break something, I'd like to learn which branches are exactly for what
> and what should I do (assuming I will get write access at some point) -
> for instance, should I create small branches for my patches?  Should
> they be branched from master?


I don't think that there are many rules about branches that are not main
branches, as it were. I've certainly made branches for smallish
features. I generally follow the "gitflow" convention with
"feature/my-new-feature" or "fix/my-fix", but this is just me. I think
very few other people do this. If I remember correctly, it's not
possible to force push, so you can't squash feature branches (remotely).

In general, branch from where ever you expect to merge to. Currently,
this means Emacs-25 iff it's a bug fix, master if it's a new feature.

Phil

Re: Branches in Emacs Git repo

[Stefan Monnier]

> I don't think that there are many rules about branches that are not main
> branches, as it were.

There are some, tho.  Mainly: if you want to play around with a branch
which you don't intend to merge directly, then use "scratch/<something>"
because other branches have to follow our coding convention for every
commit (i.e. proper commit message using the ChangeLog format).


        Stefan

Re: Branches in Emacs Git repo

[Phillip Lord]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

>> I don't think that there are many rules about branches that are not main
>> branches, as it were.
>
> There are some, tho.  Mainly: if you want to play around with a branch
> which you don't intend to merge directly, then use "scratch/<something>"
> because other branches have to follow our coding convention for every
> commit (i.e. proper commit message using the ChangeLog format).


Okay, well, I didn't know about this, although given that it's not
possible to squash a branch, I think that this covers pretty much any
branch that I would ever make.

Phil