[Tutorial] How to create pull requests for core events

[nicofuma]

What is the base branch to use for the pull requests for 3.1 as of today?

The tutorial states it is develop-ascareus, however, it is way behind 3.1.x, that seems to be more up to date.

I have tried to use develop-ascareus always, but I did some into 3.1.x, and there seems to be almost no difference...

What is the correct way to do it? Thanks,
-javiexin

3.1.x always

the develop branches have been deprecated in favour of 3.0.x 3.1.x and master branches

EDIT: I have edited the text in the first post. But for the screenshots...

[javiexin]

Thanks.

Now, I have several PRs that I made against develop-ascareus (as per this tutorial). What should I do to them?
Submit new ones against 3.1.x? Or ask someone to change them? I just do not want to have them delayed more due to this stupid mistake on my part...

My fault
-javiexin

[3Di]

Let's try to make this long story short (steps and effort)

• Fork the phpBB repository on github
• Go to the phpBB repository, not your fork
• Chose the branch/file to edit
• Click on Edit (top-left)
• Edit the file and while saving it github automatically creates a branch on you fork
• Create a PR
• Get back into the tracker and link the new PR into the ticket

Am I missing something?

[Senky]

Am I missing something?

Quite yes. The most important part is to properly fill commit message. It must start with the [ticket/<ticket_id>] and short description and end with a new line and PHPBB3-<ticket_id>. This is a requirement which will also automatically bind your PR to issue in the tracker, so you do not need to link it manually.

[3Di]

Thx. A clear example?

[RMcGirr83]

Just look at any of the PR's that have been merged...like this one for example

[bonelifer]

Thx. A clear example?

So using Rich's example:
Here's the tracker ticket url: https://tracker.phpbb.com/browse/PHPBB3-14329

So the commit title should should start with:
[ticket/14329]

Then in the body after your commit message leave a blank line and put:
PHPBB3-14329

Code: Select all

[ticket/14329] Here's my commit message

More detailed message if necessary

PHPBB3-14329

[3Di]

Very clear. Thank you all guys.

[orynider]

• Open a ticket at https://tracker.phpbb.com/ to get Ticket URL, Ticket Number and Ticket Title
• Fork the repository phpbb/phpbb to gituser/phpbb on github https://github.com/phpbb/phpbb.git
• git clone https://github.com/gituser/phpbb.git
• cd phpbb
• git -b ticket/12345
• git push ticket/12345
• Edit in a Notepad++ like editor the file or files You commit, then run the command:
  git add .
• Make a m.txt file containing the commit message:
  [ticket/12345] Ticket Title

PHPBB3-12345
  Then run the commands:
  git commit --file="c:\phpbb\m.txt"
git push origin ticket/12345
• Create a Pull Request at github.com were the PR Title will be: "[ticket/12345] Ticket Title" and the first line in pull comment will be the last line from the message file: PHPBB3-12345

[mrgoldy]

Your last item in that list has to be part of your commit message, not just your pull request message.

[orynider]

IC, I edited my post above. 10x

[3Di]

1. Github uses 8 spaces to display their tabs, so they always look wrong on github

Incidentally: add ?ts=4 to the end of a github URL to make the tabs look right

Thx, I did not know that. There should be though a more elegant solution, I mean.

[Crizzo]

There is, you can add a style information to your repo to display it as it is in the IDE.

e.g. https://github.com/LukeWCS/lf-who-was-h ... itorconfig

[3Di]

I know about .editorconfig, just I do not like to have it in my repos.
I will contact directly GitHub and report here, in case. Thanks.

[3Di]

Done, awaiting response.