Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 4.14 KB
Raw

Contributing to the Ionic Conference Application

Thank you for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the conference app. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Table of Contents

How To Contribute

Reporting Issues

Before submitting an issue, please go through the list below as you might find a solution to your issue.

Before Submitting an Issue

  • Make sure you get the latest version of the code and run through the Getting Started steps to see if this resolves your issue.
  • Check the forum for similar questions and answers.
  • Go through all issues on this repository to see if the issue has already been created. It could have been closed with a resolution, so check closed issues, too.
  • Chat with us in the #ionic-v2 channel on Slack to see if we can find a solution to the problem!
  • Determine which repository the problem should be reported in.

Determining the Repository

There are several repositories being used for Ionic, which makes it difficult to determine which one to report an issue to. Don't worry if you aren't sure, we can always move it!

  • The Ionic repository is a repository for all things related to the Ionic Framework. If you are able to reproduce the issue in any of the Ionic starters (or an existing project), you'll want to submit the issue here.
  • The Ionic CLI repository contains all of the code that allows you to run ionic commands from a terminal window. It is safe to put any issues here that relate to running an ionic command.
  • This repository is a demo of the Ionic Framework. If you find an issue with this app that does not occur on a new app, please submit the issue here.

Submitting the Issue

  • Use a clear and descriptive title for the issue to identify the problem. This makes it easier for others to find.
  • Describe the exact steps to reproduce the problem with as many details as needed.
  • Provide your configuration by running ionic info in a terminal from within the project folder and pasting this information in the issue.

Submitting a Pull Request

Guidelines for Submitting

When in doubt, keep your pull requests small. To give a PR the best chance of getting accepted, do not bundle more than one "feature" or bug fix per PR. Doing so makes it very hard to accept it if one of the fixes has issues.

It's always best to create two smaller PRs than one big one.

Talk to us before creating a PR that refactors the code or directory structure of the project. This project is constantly changing to reflect the latest version of Ionic Framework so sometimes it will be in the process of getting fixed.

Code Style

Make sure to follow the existing code style as much as possible.

  • No underscores prefixing JS functions.
  • Use flat Sass.
  • Don't use BEM conventions.
  • Avoid nesting selectors. This is done to make it easier for users without Sass experience to understand and read.