Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 3.56 KB
Raw

Contributing

This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Development

Fork, then clone the repo:

git clone https://github.com/your-username/bootstrap-loader.git

To start development simply run:

npm start

It will run linters, clear directory with previous build, create new build and run watchers to re-build on every change. Sadly, but we can't use npm link feature in development process here because this command symlinks package folder, what makes impossible to resolve bootstrap packages in project's npm_modules folder. Instead of this just install bootstrap-loader locally:

cd my-test-project
npm install --save-dev ../path/to/local/bootstrap-loader

It is a pity, but you have to re-install bootstrap-lodaer on every change.

Build

To create a build run:

npm run prerelease

It will do the same things as npm start, but without activating watchers.

Linting and Testing

To lint your code run:

npm run lint

Shame on us, but we don't have any tests here yet. We will be happy, if you can give us a hand with it.

How loader works

There are 2 entry points: ./loader.js & ./extractStyles.js. These are the dummy loaders, which apply real loader to dummy no-op.js file. The source of the real loader is located in ./src/bootstrap.loader.js. Before exploring things in it, check out ./src/bootstrap.config.js to figure out how we handle default / user config files & gather options for loader.

The main purpose of ./src/bootstrap.loader.js is to resolve location of bootstrap package and create requires for webpack to invoke ./src/bootstrap.styles.loader.js and ./src/bootstrap.scripts.loader.js. Those are responsible for loading bootstrap's SCSS styles and jQuery scripts.

If you have any questions about further details – don't hesitate to create an issue.

Examples

Bootstrap loader comes with examples to demonstrate how to implement it in various cases. Currently there are 2 example apps: basic implementation and implementation with CSS Modules. Check out theirs READMEs to find out how to use them.

New Features

Please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

Style

Shakacode is trying to keep a standard style across its various projects, which can be found over in eslint-config-shakacode. If you have a style change proposal, it should first be proposed there. If accepted, we will be happy to accept a PR to implement it here.

Submitting Changes

  • Open a new issue in the issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Make sure there are no linting errors and all tests pass (if any).
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!