Skip to content

Latest commit

 

History

History
186 lines (125 loc) · 6.79 KB

CONTRIBUTING.md

File metadata and controls

186 lines (125 loc) · 6.79 KB
Raw

Contributing to lumX

We'd love for you to contribute to our source code and to make AngularJS even better than it is today! Here are the guidelines we'd like you to follow:

Code of Conduct

As heavy users of Angular, we encourage you to read and follow the Angular Code of Conduct.

Got a question or a problem?

If you have questions about how to use AngularJS, please direct these to StackOverflow.

Found an issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.

Please see the Submission Guidelines below.

Want a feature?

You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature then consider what kind of change it is, discuss it with us before hand in your issue, so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.

Submission guidelines

Submitting an issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Motivation for or Use Case - explain why this is a bug for you
  • lumX Version(s) - is it a regression?
  • Browsers and Operating System - is this a problem with all browsers or only IE8?
  • Reproduce the Error - provide a live example (using Plunker or JSFiddle) or a unambiguous set of steps.

Submitting a pull request

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
  • Make your changes in a new git branch
git checkout -b my-fix-branch master
gulp dist
  • Push your branch to GitHub:
git push origin my-fix-branch
  • In GitHub, send a pull request to lumx:master.
  • If we suggest changes then
  • Make the required updates.
  • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase master -i
git push -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete my-fix-branch
  • Check out the master branch:
git checkout master -f
  • Delete the local branch:
git branch -D my-fix-branch
  • Update your master with the latest upstream version:
git pull --ff upstream master

Coding rules

We're using Javascript and SCSS to build the framework. A Gulpfile is in the project to help you contribute:

  • gulp will build the project and watch for modifications.
  • gulp dist will update the dist folder with the last contents.

The dist folder must be update inside your pull requests. If there is conflicts, just ignore them as the dist folder must be only the result of the generation.

Our coding convention is the following:

Git commit guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

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:

<type> <scope>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools.

Type

Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug or adds a feature
  • perf: A code change that improves performance
  • chore: Changes to the build process or auxiliary tools and libraries such as distribution generation

Scope

The scope could be anything specifying place of the commit change. For example `notification', 'dropdown', etc.

Body

The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes. The breaking changes must be at the end of the commit with only on "BROKEN:" before the list of breaking changes. They must be each on a new line.

Commit example

feat TOTO: TOTO for all

Before we had to do XXX. There was this and this problem. Now, by using TOTO, it's simpler and the problems are managed.

Closes PR #25
Fix #15
BROKEN:
first thing broken
second thing broken