Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

53 lines (35 loc) · 3.98 KB
Raw

Contributing Guide

We value your and our time, we created this Guidline to avoid unnecessary diffuculties with pull requests and contribution process.

Please read the text below before starting your improvements in order to help us make cooperation and reviewing experience as pleasent and effective as possible.

Not following these rules and procedures may entail closing issues or rejection of your work even if it's theoreticly adequate.

Issues and Support

  1. Use Support Forum - don't use GitHub Issues for personal questions and support requests. We're maintaining a dedicated Support Forum for this purpose. This is also a go-to place for every suggestion, opinion, bugs, and issue reports - if you'd like to receive help as soon as possible. Reports posted on Support Forum are prior to GitHub issues.

  2. Check available resources - always check current issues before opening your own. Also check Support Forum and Documentation - most likely you'll find your answer there. Unchecked issues and duplicates will be closed immediatelly.

  3. Examine issue source - MDB code is depending on other projects, mainly Bootstrap. Don't open issues concerning sources we cannot influence. For example - lack of flexbox support for older IE versions is determined by Bootstrap not MDB.

  4. Check updates - We resolve most of reported bugs and issues with every new release. Check if your MDB version is the latest. You can take a look at our changelog to find if your problem wasn't already taken care of. If you want to keep track on updates and bug fixes, the best way is joining our newsletter here.

  5. Be specific - describe your case in English, clearly and with details. Attach code examples, screenshots, links and any other relevant resources.

Contributing Standards

All improvements, fixes and new elements are welcome and we're deeply grateful for every help attempt. Although we recommend thinking twice before starting. We don't want to waste your time and some changes may be rejected not becouse of their quality but simply as a result of different style, organization or prefifined procedures we maintain. That's why we came up with standards below, following them will maximize the chance of your contribution beeing included in project.

  1. Make sure that your idea doesn't contradict the concepts of Bootstrap, Material Design and Angular
  2. Verify if it fits the rest of MDB envoirement and style
  3. Write and form your code accordingly to those rules
  4. Use Gulp to minify your code after finishing
  5. Create clear titles and detailed descriptions for your Pull Requests

Submitting a Pull Request

Before you submit your Pull Request (PR) consider the following guidelines:

  1. Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

  2. Fork the mdbootstrap/Angular-Bootstrap-with-Material-Design repo.

  3. Make your changes in a new git branch:

    git checkout -b your-branch-name master

  4. Commit your changes using a descriptive commit message.

  5. Push your branch to GitHub

    git push origin your-branch-name

  6. In GitHub, send a pull request to Angular-Bootstrap-with-Material-Design:dev

Thank you for your contribution!

Questions

If you're not sure about your ideas or you'd like to talk about them with our team before starting, write to: [email protected], and for every query regarding technical consultance open your case on Support Forum