Skip to content

Latest commit

 

History

History
156 lines (105 loc) · 6.81 KB

CONTRIBUTING.md

File metadata and controls

156 lines (105 loc) · 6.81 KB
Raw

Contributing to iTop

You want to contribute to iTop? Many thanks to you! 🎉 👍

Here are some guidelines that will help us integrate your work!

Contributions

Subjects

You are welcome to create pull requests on any of those subjects:

  • 🐛 bug fix
  • 🌐 translation / i18n / l10n

If you want to implement a new feature, please create a corresponding ticket for review.
If you ever want to begin implementation, do so in a fork, and add a link to the corresponding commits in the ticket.

For all security related subjects, please see our security policy.

All datamodel modification should be done in an extension. Beware that such change would impact all existing customers, and could prevent them from upgrading! Combodo has a long experience of datamodel changes: they are very disruptive! This is why we avoid them in iTop core, especially the changes on existing objects/fields.
If you have an idea you're sure would benefit to all of iTop users, you may create a corresponding ticket to submit it, but be warned that there are lots of good reasons to refuse such changes.

📄 License

iTop is distributed under the AGPL-3.0 license (see the license.txt file), your code must comply with this license.

If you want to use another license, you may create an extension.

🔀 iTop branch model

When we first start with Git, we were using the GitFlow branch model. As there was some confusions about branches to use for current developed release and previous maintained release, and also because we were using just a very few of the GitFlow commands, we decided to add just a little modification to this branch model : since april 2020 we don't have a master branch anymore.

Here are the branches we use and their meaning :

  • develop: ongoing development version
  • release/*: if present, that means we are working on a alpha/beta/rc version for shipping
  • support/*: maintenance branches for older versions

For example, if no version is currently prepared for shipping we could have:

  • develop containing future 3.0.0 version
  • support/2.7: 2.7.x maintenance version
  • support/2.6: 2.6.x maintenance version
  • support/2.5: 2.5.x maintenance version

In this example, when 3.0.0-beta is shipped that will become:

  • develop: future 3.1.0 version
  • release/3.0.0: 3.0.0-beta
  • support/2.7: 2.7.x maintenance version
  • support/2.6: 2.6.x maintenance version
  • support/2.5: 2.5.x maintenance version

And when 3.0.0 final will be out:

  • develop: future 3.1.0 version
  • support/3.0: 3.0.x maintenance version (will host developments for 3.0.1)
  • support/2.7: 2.7.x maintenance version
  • support/2.6: 2.6.x maintenance version
  • support/2.5: 2.5.x maintenance version

Also note that we have a "micro-version" concept : each of those versions have a very small amount of modifications. They are made from support/* branches as well. For example 2.6.2-1 and 2.6.2-2 were made from the support/2.6.2 branch.

Coding

🌐 Translations

A dedicated page is available in the official wiki.

Where to start ?

  1. Create a fork from our repository (see Working with forks - GitHub Help)
  2. Create a branch in this fork, based on the develop branch
  3. Code !

Do create a dedicated branch for each modification you want to propose : if you don't it will be very hard to merge back your work !

Most of the time you should based your developments on the develop branch.
That may be different if you want to fix a bug, please use develop anyway and ask in your PR if rebase is possible.

🎨 PHP styleguide

Please follow our guidelines.

✅ Tests

Please create tests that covers as much as possible the code you're submitting.

Our tests are located in the test/ directory, containing a PHPUnit config file : phpunit.xml.dist.

Git Commit Messages

  • Describe the functional change instead of the technical modifications
  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Please start the commit message with an applicable emoji code (following the Gitmoji guide).
    Beware to use the code (for example :bug:) and not the character (🐛) as Unicode support in git clients is very poor for now...
    Emoji examples :
    • 🌐 :globe_with_meridians: for translations
    • 🎨 :art: when improving the format/structure of the code
    • ⚡️ :zap: when improving performance
    • 🐛 :bug: when fixing a bug
    • 🔥 :fire: when removing code or files
    • 💚 :green_heart: when fixing the CI build
    • ✅ :white_check_mark: when adding tests
    • 🔒 :lock: when dealing with security
    • ⬆️ :arrow_up: when upgrading dependencies
    • ⬇️ :arrow_down: when downgrading dependencies
    • ♻️ :recycle: code refactoring
    • 💄 :lipstick: Updating the UI and style files.

👥 Pull request

When your code is working, please:

  • stash as much as possible your commits,
  • rebase your branch on our repo last commit,
  • create a pull request.

Detailed procedure to work on fork and create PR is available in GitHub help pages.

You might check the "Allow edits from maintainers" PR checkbox to ease review.

🙏 We are thankful

We are thankful for all your contributions to the iTop universe! As a thank you gift, we will send stickers to every iTop (& extensions) contributors!

Stickers' design might change from one year to another. For the first year we wanted to try a "craft beer label" look, see examples below:

  • Bug hunter: Fix a bug
  • Translator: Add/update translations
  • White hat: Find and/or fix a vulnerability
  • Contributor: Contribute by finding a bug, making an extension or any other way
  • Partner: For Combodo's official partners