Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 2.61 KB
Raw

Welcome, Contributor!

On behalf of the entire Fluid Powered TYPO3 team, thank you for wanting to contribute to our projects - by creating issues, pull requests or just asking great support questions which can help other users in the future.

This is the ultra-compact guide for that.

Submitting Issues - Feature Requests, Bug Reports, Support Questions...

You have heard all this before, but just in case:

  • Before submitting bugs, make sure the bug you are reporting...
    • Is not already fixed (if in doubt: the Git master branch is always up-to-date)
    • Is not currently reported and/or under review
  • When submitting bugs, include information about what you wanted to achieve and which errors or messages (reminder: error log messages are worth a thousand words) you encountered.

In short: We want to trust that your report is valid and contains helpful information. This allows us to be most efficient when assisting or fixing the problem; everything runs smoother.

Contributing Code

In order to ensure that your contribution passes through with flying colors (we have automated tests for all of these factors) there are a few things you can do.

  • Follow the coding guidelines - viewing any class will give you a clear picture of our standards which we always enforce. Each extension has perfect or near-perfect guidelines compliance and contributed code should not lower compliance. If you spot a violation in the code, we of course also appreciate contributions which do nothing but fix cosmetics!
  • Use a valid commit message subject. When you write your commit messages (note: the ones you write in Git itself, not the same as the Pull Request cover message!) always start your message with one of [DOC], [BUGFIX], [TASK] or [FEATURE] to describe the nature of your commit's changes.
  • Make one commit per change and one change per commit only. Example: if you are going to create a particular feature and this feature requires a few changes to existing code to prepare for the feature, first make individual commits with the required changes and then create your "real" work on top of this.
  • Recommendation: plan a few steps ahead, try to group your work into logical "chunks" of code which are easier to manage, then commit each "chunk" of work as you finish it. There is one time management strategy worth mentioning in this context: the Pomodoro technique.

The full guide is available at http://fedext.net/overview/contributing/contribution-guide.html

Last words: welcome to the growing list of contributors! :)