Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

// Pull Request template proposal #5080

Merged
merged 5 commits into from Mar 1, 2016

Conversation

@xBorderie
Copy link
Contributor

commented Feb 26, 2016

Description

This PR adds a PR template to the repository, as made possible by recent updates to GitHub. We hope this will help the community create better PR!

More info about GitHub PR templates: https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/

Note that this creates an invisible .github/ directory at the root of project (see last paragraph of first link).

Reference any other pull requests that might be related (for instance, if you are rebasing a PR from another branch).
-->

This PR is a (BUG FIX / NEW FEATURE / TEXT CHANGE). <!-- Delete the unneeded mentions and add your long description right below. -->

This comment has been minimized.

Copy link
@mickaelandrieu

mickaelandrieu Feb 26, 2016

Member

You need to put your comment a line below in order to be correctly parser by Github (see the preview).

Or maybe is that intended ?

This comment has been minimized.

Copy link
@xBorderie

xBorderie Feb 26, 2016

Author Contributor

My mistake! Fixed, thanks!

@mickaelandrieu

This comment has been minimized.

Copy link
Member

commented Feb 26, 2016

Nice contribution !

I'm not sure of the interest of commented markdown cause contributors won't never see this content.
In your opinion, how many time of contributor attention do we have ? 30s, 1min, minutes ?

@xBorderie

This comment has been minimized.

Copy link
Contributor Author

commented Feb 26, 2016

I agree that the whole intro is overly long for now, but I want to iterate on this with the first few PR. I do hope that see this block of text will push contributors to pay better attention to the way they fill their PR description field. We'll see with the first results!

@kpodemski

This comment has been minimized.

Copy link
Contributor

commented Feb 26, 2016

@xBorderie you should add information about BO: FO: MO: CORE: here, people will save some time instead of going to yet another website to read the docs

@xBorderie

This comment has been minimized.

Copy link
Contributor Author

commented Feb 26, 2016

@kpodemski I'm not sure, there's a already a lot of content in the header. I know that they are unlikely to click a link, but I'm afraid there's already a lot in there. Do you have a suggestion?

@kpodemski

This comment has been minimized.

Copy link
Contributor

commented Feb 26, 2016

One simple paragraph:

About commits name

Commit name has three parts:
[-] + FO : + Your commit name for things related to Front-Office

[-] means that commit is about bug fix, it can be also:
[*] for improvement and:
[+] for new feature

FO : means that commit is related to Front-Office, it can be also:
BO : for back-office,
MO : for modules,
CORE : for Core

last part is your commit regular name.

It can be tricky when people sees PRs like:
// Something

so I think this information should be in this file

@xBorderie

This comment has been minimized.

Copy link
Contributor Author

commented Feb 26, 2016

Ah, was adding your idea and simplifying the intro while you were typing your suggestion. What do you think!
You're right about //, I'll add it -- and in the doc page as well.

@kpodemski

This comment has been minimized.

Copy link
Contributor

commented Feb 26, 2016

@xBorderie it's good :) you can also add MO : and information that it is related to modules repositories

@kpodemski

This comment has been minimized.

Copy link
Contributor

commented Feb 26, 2016

👍

@xBorderie

This comment has been minimized.

Copy link
Contributor Author

commented Mar 1, 2016

Let's go and iterate!

xBorderie added a commit that referenced this pull request Mar 1, 2016
Merge pull request #5080 from xBorderie/PR-template
// Added Pull Request template

@xBorderie xBorderie merged commit fba0984 into PrestaShop:develop Mar 1, 2016

1 check failed

continuous-integration/travis-ci/pr The Travis CI build failed
Details

@xBorderie xBorderie deleted the xBorderie:PR-template branch Jun 7, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.