Skip to content
This repository has been archived by the owner on Mar 27, 2019. It is now read-only.

Latest commit

 

History

History
63 lines (39 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.78 KB

Contributor Policy

  1. Development Process
  2. Bug Reporting
    1. What is considered a bug?
    2. How do I report a bug?
    3. How quickly will my bug be fixed?
  3. Feature Requests
  4. Pull Requests
    1. Commit Message Format
    2. Code Syntax and Guidelines

Development Process

Boundless is primarily developed by Evan Scott and Enigma's FE team. The CHANGELOG will be updated with each release and a git tag will be created.

Bug Reporting

What is considered a bug?

If a component deviates from the spec outlined in its documentation (README.md), then that errant behavior is a bug.

How do I report a bug?

Create a new entry in the repository issue tracker.

How quickly will my bug be fixed?

The Boundless team is committed to fixing verified bugs as soon as possible. Depending on the complexity of the issue, a release to address it could be cut the same day, but time must be allowed to add regression testing and verify the fix in all supported browsers.

Feature Requests

Boundless addresses a specific need: to normalize behavior in common UI patterns and provide easily-composable components that do not require significant rewriting or tweaking for every new project.

If you have an idea for functionality or a new component to be added to the kit, we welcome such requests in our issue tracker. If the request is too specific to your project's implementation, it will likely be rejected.

Pull Requests

Community pull requests (PRs) will only be considered for bug fixes and performance-related improvements.

At this time, we are not accepting PRs for new components or functionality. Instead, follow the feature request procedure and, if it makes sense, we will include it in our roadmap.

Commit Message Format

Commit messages should be written in present tense. For example, "Replace Foo with Bar" instead of "Replaced Foo with Bar".

Adhere to the 70/120 rule when writing commit messages:

  1. The title line should be no more than 70 characters
  2. Separate the title and body with an empty newline
  3. The commit message body can be as long as you want, hard-wrapped at 120 characters per line

Example:

Site / README updates

Adding User Interface Guideline suggestions (thanks Eris!) and tweaking
some of the styles and demos.

Code Syntax and Guidelines

Boundless follows a variant of the AirBnB JS style guide. Lint your submission via npm run lint to ensure that you are in compliance before sending a PR.