[DEVELOPER] Developer Guidelines

Schlaefer edited this page Mar 17, 2018 · 13 revisions

Development Guidelines

Talk to People

Always check for existing issues or pull-requests first. Comment or vote for them.

Please create an issue first and let us discuss this change, before you do any changes. Not all changes will be accepted by the maintainer of the project, you can save a lot of time if you talk to us, before start coding.

Gitter.im is also a good place to throw arround ideas in an informal way. Lets talk to each other, to improve PhileCMS.

Patch / Pull Request Workflow

  1. Fork Phile on github
  2. Make your changes
  3. Run the test cases locally (call ./phing in the root and choose "run test suite"), make sure no test fails
  4. Create a pull request on github into the develop branch
  5. Travis CI will build and test your pull request automatically, if all tests passed go to next step
  6. Each pull request has to be reviewed by two other people. If the pull request is reviewed by at least two people (give +1 in the comments), one of the maintainer will accept the request and merge it into the core.

The maintainers also has a veto, in cases where the code structure is not Ok or an other pull request will add the same feature.

For each pull request please use one of the following prefix:

[FEATURE]

If you implement a new feature, please use this prefix in the title of the pull request.

[BUGFIX]

If you fix any bug, please use this prefix in the title of the pull request.

If you fix a already documented bug, pleaser refer to the issue in the issuetracker.

GIT Commit Message Template

Please use the following GIT commit message template, for any pull request.

You can use a custom template for getting the commit message faster done.

All you need is the template below and the command

git config --local commit.template .gitmessage.txt

We have added the .gitmessage.txt file to the root of the project.

[BUGFIX|FEATURE|TASK] Short summary of changes introduced by this patch

More detailed explanatory text, if necessary.

Resolves: #12345 (refer to github issue number)
Documentation: #12346 (refer to github issue number, where a documentation is available)
Releases: 0.9.3 (this should be the next version number, please ask the core developer before you fill in this information or leave it blank
Related: #1234, #1235 list here all related github issue numbers
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.