Newcomer's questions

[Alexey Tsivunin]

I worked on issue and fixed a bug. So a have three commits (in the sequence they were commited):
- Added regression tests
- Added bugfix
- Added name to AUTHORS

This is my first PR and I have several questions:

1. I don't quite understand about "headers" in commit messages. Which commit should have header like "[2.0.x] Fixed #29471 -- "? Or each of them should have it?

2. Does my fork have to be up-to-date with original django repo before I make the PR? If so, is there any guides how I can do this?

3. Should I select "Allow edits from maintainers" when creating PR?

[Aymeric Augustin]

Hello Alexey,

Thanks for contributing!

1. You should make a PR against master and, if you're fixing a Trac ticket, start the commit message with "Fixed #xxxxx -- bla bla bla".

Version indicators such as [2.0.x] are added when patches are backported to stable branches. You don't need to care about this now. If your issue is eligible for backporting, then the person who merges the patch will likely do the backport as well.

2. Yes, your fork should be up to date with Django's master branch to ensure that the PR is clean.

See Working with git / After upstream has changed for details (read the whole page, commands listed in that paragraph depend on other commands listed earlier).

3. As you wish :-)

I'm not aware of any guidelines about this relatively new GitHub feature when contributing to Django.

Best regards,

-- 

Aymeric.

--
You received this message because you are subscribed to the Google Groups "Django developers (Contributions to Django itself)" group.
To unsubscribe from this group and stop receiving emails from it, send an email to django-develop...@googlegroups.com.
To post to this group, send email to django-d...@googlegroups.com.
Visit this group at https://groups.google.com/group/django-developers.
To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/e550ba3f-c6d4-49f5-94e2-29cfd0ee6798%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Adam Johnson]

3. I believe I’ve seen Tim use the maintainers’ edits feature. Perhaps we should guide towards its usage?

To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/87832FCE-FA46-4717-BB1C-E6F0F8795694%40polytechnique.org.

For more options, visit https://groups.google.com/d/optout.

--

Adam

[charettes]

I can be a quite useful option when mergers have to perform small typos and code style tweaks before a merge.

I'm not sure it's worth documenting given it's the default value though.

Simon

[Alexey Tsivunin]

I'm working on issue #29471. This issue have version 2.0. Do I need to add version indicator in that case?

if you're fixing a Trac ticket, start the commit message with "Fixed #xxxxx -- bla bla bla".

I still don't understand which of three commits must have that header. First? Or all of them?

[Tim Graham]

On Sunday, March 17, 2019 at 9:43:29 PM UTC-4, Alexey Tsivunin wrote:

I'm working on issue #29471. This issue have version 2.0. Do I need to add version indicator in that case?

No, the "Version" flag on the ticket merely indicates when the ticket was reported.

 

if you're fixing a Trac ticket, start the commit message with "Fixed #xxxxx -- bla bla bla".

I still don't understand which of three commits must have that header. First? Or all of them?

You should squash the commits into one.