Skip to content

Latest commit

 

History

History
268 lines (187 loc) · 10.8 KB

CONTRIBUTING.md

File metadata and controls

268 lines (187 loc) · 10.8 KB
Raw

Contributing to bootsrap-material-design

Looking to contribute something to bootsrap-material-design? Here's how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests, but please respect the following restrictions:

  • Please do not use the issue tracker for personal support requests. Stack Overflow bootstrap-material-design tag) is the best place to get help.

  • Please do not open issues without a reduced test case and a live example using this CodePen. Failure to submit a test case may result in the issue being closed.

  • Please do not open issues without clearly stating the problem and desired result. See the bug reports section for more information on creating effective issues.

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

  • Please do not open issues or pull requests regarding the code in dependencies such as: Bootstrap (open them in their respective repositories).

  • Please do not leave resolved issues open e.g. a question that has been answered.

Bug reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

  1. Validate and lint your code — validate your HTML and lint your HTML to ensure your problem isn't caused by a simple error in your own code.

  2. Use the GitHub issue search — check if the issue has already been reported.

  3. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  4. Isolate the problem — and create a reduced test case and a live example. This CodePen is a starter template.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> - a link to the reduced test case (via the CodePen template)

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

Issues and labels

Our bug tracker utilizes several labels to help organize and identify issues. Here's what they represent and how we use them:

  • bug confirmed - Issues that have been confirmed with a reduced test case and identify a bug in Bootstrap.
  • docs & examples - Issues for improving or updating our documentation or examples.
  • feature - Issues asking for a new feature to be added, or an existing one to be extended or modified. New features require a minor version bump (e.g., v3.0.0 to v3.1.0).
  • enhancement - Issues for improving existing features
  • grunt - Issues with our included JavaScript-based Gruntfile, which is used to run all our tests, concatenate and compile source files, and more.
  • help wanted - Issues we need or would love help from the community to resolve.
  • js - Issues stemming from our compiled or source JavaScript files.

For a complete look at our labels, see the project labels page.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project and the Google Material Design specification itself. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding guidelines used throughout the project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

In general, do not edit dist or sass files directly! Those files are automatically generated. You should edit the source files in /less/ and/or /scripts/ instead.

Similarly, when contributing to documentation, you should edit the documentation source files in the /docs/ directory of the master branch. Do not edit the gh-pages branch. That branch is generated from the documentation source files and is managed separately by the bootstrap-material-design Team.

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/bootstrap-material-design.git
# Navigate to the newly cloned directory
cd bootstrap
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/FezVrasta/bootstrap-material-design.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout master
git pull upstream master

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks with messages written in english. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream master

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description against the master branch.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License (if it includes code changes) and under the terms of the Creative Commons Attribution 3.0 Unported License (if it includes documentation changes).

Code guidelines

HTML

Adhere to the Code Guide.

  • Use tags and elements appropriate for an HTML5 doctype (e.g., self-closing tags).
  • Use CDNs and HTTPS for third-party JS when possible. We don't use protocol-relative URLs in this case because they break when viewing the page locally via file://.
  • Use WAI-ARIA attributes in documentation examples to promote accessibility.

CSS

Adhere to the Code Guide.

JS

  • No semicolons (in client-side JS)
  • 2 spaces (no tabs)
  • strict mode
  • "Attractive"

Checking coding style

Run grunt build before committing to ensure your changes follow our coding standards.

License

By contributing your code, you agree to license your contribution under the MIT License. By contributing to the documentation, you agree to license your contribution under the Creative Commons Attribution 3.0 Unported License.

Building documentation

  1. Checkout the master branch from the project root directory

    $ git checkout master

  2. Bundle install (if not already done)

    $ bundle install

  3. Checkout the gh-pages branch in _gh_pages directory

    $ git clone [email protected]:FezVrasta/bootstrap-material-design.git -b gh-pages _gh_pages

    rosskevin only note when ready kill all files and commit a clean gh-pages directory for a clean start.

    The _gh_pages directory is already in .gitignore so we are just fine.

  4. Copy the latest code to the docs/dist (if not already done)

    $ grunt docs

  5. Let's test changes to the documentation:

    $ jekyll serve

  6. Browse to http://127.0.0.1:9001/

  7. Make some changes to files in the docs directory and review them

  8. Commit and push the newly generated site on github:

    $ cd _gh_pages
$ git add .
$ git commit -m "First generation"
$ git push