[Tutorial] How to create pull requests for core events

Discussion forum for Extension Writers regarding Extension Development.
nicofuma
3.2 Release Manager
3.2 Release Manager
Posts: 546
Joined: Sun Apr 13, 2014 1:47 am
Location: Grenoble - France

Re: [Tutorial] How to create pull requests for core events

Post by nicofuma »

javiexin wrote: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...
Member of phpBB Development-Team
No Support via PM
User avatar
javiexin
Code Contributor
Posts: 1157
Joined: Wed Oct 12, 2011 11:46 pm
Location: Madrid, Spain
Name: Javier

Re: [Tutorial] How to create pull requests for core events

Post by 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
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 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?
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades
Senky
Former Team Member
Posts: 2300
Joined: Thu Apr 30, 2009 8:49 pm
Name: Jakub

Re: [Tutorial] How to create pull requests for core events

Post by Senky »

3Di wrote: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.
β€Žβ€β€ β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Ž β€Žβ€β€Žβ€β€β€Ž β€Ž β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Ž β€Žβ€β€β€Žβ€β€β€ŽπŸ””
Browser & Mobile Notifications Extension
Now with Safari (both macOS and iOS) support!
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 3Di »

Thx. A clear example?
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
RMcGirr83
Former Team Member
Posts: 22034
Joined: Wed Jun 22, 2005 4:33 pm
Location: Your display
Name: Rich McGirr

Re: [Tutorial] How to create pull requests for core events

Post by RMcGirr83 »

Just look at any of the PR's that have been merged...like this one for example
Former Modifications/Extensions Team Member | My extensions | github | All requests for support via PM will be ignored
Appreciate the extensions/mods/support then you can support me by buying a beer 🍺
User avatar
bonelifer
Community Team Member
Community Team Member
Posts: 3618
Joined: Wed Oct 27, 2004 11:35 pm
Name: William

Re: [Tutorial] How to create pull requests for core events

Post by bonelifer »

3Di wrote: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
William Jacoby - Community Team
Knowledge Base | phpBB Board Rules | Search Customisation Database
Please don't contact me via PM or email for phpBB support .

phpBB Modders is looking for developers! If you have phpBB experience and want to join us, click here!
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 3Di »

Very clear. Thank you all guys. :)
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
orynider
Translator
Posts: 273
Joined: Wed Nov 16, 2005 12:48 pm
Location: Arad, RomΓ’nia
Name: Florin-Ciprian Bodin

Re: [Tutorial] How to create pull requests for core events

Post by 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
Last edited by orynider on Tue Dec 04, 2018 10:14 pm, edited 5 times in total.
User avatar
mrgoldy
Former Team Member
Posts: 1394
Joined: Tue Oct 06, 2009 7:34 pm
Location: The Netherlands
Name: Gijs

Re: [Tutorial] How to create pull requests for core events

Post by mrgoldy »

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

Contributing: You can do it too! β€’ Including testing Pull Requests (PR).
phpBB Development and Testing made easy.
User avatar
orynider
Translator
Posts: 273
Joined: Wed Nov 16, 2005 12:48 pm
Location: Arad, RomΓ’nia
Name: Florin-Ciprian Bodin

Re: [Tutorial] How to create pull requests for core events

Post by orynider »

IC, I edited my post above. 10x :D
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 3Di »

gothick wrote: ↑Mon Feb 02, 2015 12:47 pm
VSE wrote: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.
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
Crizzo
Translations & International Support Teams Manager
Translations & International Support Teams Manager
Posts: 1734
Joined: Thu Apr 23, 2009 1:20 pm
Location: Stuttgart, Germany
Name: Christian

Re: [Tutorial] How to create pull requests for core events

Post by 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
My extensions for phpBB: CDB
German phpBB Support at www.phpbb.de
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 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. :)
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades
User avatar
3Di
I've Been Banned!
Posts: 17538
Joined: Mon Apr 04, 2005 11:09 pm
Location: I'm with Ukraine 🇺🇦
Name: Marco

Re: [Tutorial] How to create pull requests for core events

Post by 3Di »

Done, awaiting response.
πŸ†“ Free support for our extensions also provided here: phpBB Studio
πŸš€ Looking for a specific feature or alternative option? We will rock you!
Please PM me only to request paid works. Thx. Buy me a coffee -> Image
My development's activity ΒΊ PhpStorm's proud user ΒΊ Extensions, Scripts, MOD porting, Update/Upgrades

Return to β€œExtension Writers Discussion”