Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
187 lines (131 sloc) 10.1 KB

Contributing to OVH-UX projects

OVH guidelines

PRs Welcome Gitter

🚧 This guidelines are under active discussions, so some of our projects do not yet use this configuration

👍🎉 First off, thanks for taking the time to contribute!

«Developing a new project is like rolling on a green field, maintaining it is a sometimes a dark twisted nightmare. Here's a list of our guidelines, If you want to share a best practice, or think one of these guidelines should be removed, feel free to share it with us.»

Table Of Contents

  1. TL;DR
  2. Code of Conduct
  3. I just have a question!
  4. How Can I Contribute?
  5. Coding with style
  6. Licensing

TL;DR

You're so excited to contribute that you do not have time to read the entire document. Here you will find some keys to quickly and safety contribute. 😉

  1. Gitter, the official OVH-UX message board. Feel free to discuss with us.
  2. Just be cool and respectful with others
  3. Use this configuration file to respect our javascript guidelines and our javascript styleguides
  4. Use this configuration file to respect our css, sass styleguides
  5. Your code should be tested
  6. Respect this simple commit message template
<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Where type can be :

  • feat: A new feature
  • fix: A bug fix
  • chore: Refactoring, Changing the build process or auxiliary tools and libraries etc.
  • docs: Documenation writing
  • style: Cosmetics purpose
  • test: Adding missing or correcting tests
  1. For the subject, use the present tense ("Add feature" not "Added feature")
  2. Should be submitted through Github Pull Requests on develop.

Now, if you want to go further, sit comfortably at the fireplace, grab your glasses and immerse yourself in our documentation.

Code Of Conduct

All projects and everyone participating in it is governed by OVH Code Of Conduct. By participating, you are expected to uphold this code. Please read this before.

I just have a question!

Note: Please don't file an issue to ask a question. You'll get faster results by using the resource below.

We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.

How Can I Contribute?

So, you've developed a new cool feature? Fixed an annoying bug? Found a mistake? We'd be happy to hear from you! 👍

If you are not comfortable with GitHub, just take a look to this courses

Finding Wonderful Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster. We have a template to create issues. Please use this template.

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining wich brower and it's version. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of an input, explain if you used the mouse, or a keyboard.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.

Any Feedback To Enhance Our Apps

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed. Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
  • Explain why this enhancement would be useful to most OVH users.

Your awesome And Mighty Codes Contributions

This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

Coding with style

Git Commit Messages

Having a good guideline for creating commits and sticking to it makes working with Git and collaborating with others a lot easier.

We have a commitizen plugin to follow our git guideline.

Here are some rules of thumb :

  • Use the present tense ("Add feature" not "Added feature")
  • If you have a body, separate the subject from the body with a newline
  • Limit the subject line to 72 characters
  • Do not end the subject line with a period
  • Use imperative mood in the subject line
  • If the subject is not clear enough, use the body to explain what and why as opposed to how
  • Consider starting the commit message with an applicable emoji, when you feel it's an important commit :
    • 🎉 When first / initial commit
    • When introducing new features
    • 🚑 When fixing a bug
    • 🤝 When merging files
    • 🚜 When you changing file structure or refactoring
    • 📚 When writing docs
    • 💎 When new Release
    • 💄 For cosmetics purposes

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<emoji> <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Examples:

:sparkles: feat(voip): add simultaneous lines

Add all feature available in OVH api to add or order simultaneous lines for your phone

close #47
:gem: Release v1.0.2

JavaScript Styleguide

We are strong supporters of the new features enabled by the ECMAScript 6 language, you can read more about our javascript guidelines to be compliant with our pratices. To be sure to respect our formatting and style, use this configuration file

Less/Sass Styleguide

To be sure to respect our guidelines, use this configuration file.

Licensing

For all new projects and most of older one we use BSD 3-clause "New" or "Revised" License. You can find it here.

Make sure to use resources that we have the rights to use. If you use libraries, remember to look for MIT, Apache or BSD but if you modify them, then take a look into license details. Copyrighted images and videos may cause legal problems.


This document is strongly inspired by the following resources: project-guidelines, Atom Guidelines, Angularjs guidelines.

With love ❤️

You can’t perform that action at this time.