Merge pull request #17 from shakacode/alex/contributing

Add contributing guide

Author: alex35mil

CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Reporting Issues and Asking Questions
+Before opening an issue, please search the [issue tracker](https://github.com/shakacode/bootstrap-loader/issues) 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-lodaer
+```
+
+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 `require`s 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](examples) to demonstrate how to implement it in various cases. Currently there are 2 example apps: [basic implementation](examples/basic) and [implementation with CSS Modules](examples/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](https://github.com/shakacode) is trying to keep a standard style across its various projects, which can be found over in [eslint-config-shakacode](https://github.com/shakacode/style-guide-javascript). 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](https://github.com/shakacode/bootstrap-loader/issues).
+* 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!

README.md

@@ -5,7 +5,6 @@
 Successor to [bootstrap-sass-loader](https://github.com/shakacode/bootstrap-sass-loader). Load Bootstrap styles and scripts in your Webpack bundle. This loader uses SASS to process CSS styles. Bootstrap 3 & 4 are supported.
 
 ## Installation
-
 Get it via npm:
 
 ```bash
@@ -26,7 +25,6 @@ npm install css-loader node-sass resolve-url-loader sass-loader style-loader url
 ```
 
 ## Usage
-
 Simply require it:
 
 ```js
@@ -82,14 +80,12 @@ scripts:
 If no config provided, default one for Bootstrap 3 will be used.
 
 ## Examples
-
 Check out example apps in [`examples/`](examples) folder:
 
 * Basic usage: [examples/basic](examples/basic)
 * With CSS Modules: [examples/css-modules](examples/css-modules) (This example shows off hot reloading with Babel 6 as well!)
 
 ## Common Options for Bootstrap 3 and 4
-
 Here are common options for Bootstrap 3 & 4.
 
 ### Bootstrap 3
@@ -221,7 +217,6 @@ scripts: true / false
 ```
 
 ### Bootstrap 4
-
 There is only one additional option for Bootstrap 4:
 
 #### `useFlexbox`
@@ -237,7 +232,6 @@ useFlexbox: true
 ## Additional configurations
 
 #### Paths to custom assets
-
 If you use `bootstrap-loader` to load your styles (via `preBootstrapCustomizations`, `bootstrapCustomizations` & `appStyles`) and you load custom assets (fonts, images etc.), then you can use relative paths inside `url` method (relative to SASS file, from which you load asset).
 
 This was made possible thanks to [resolve-url-loader](https://github.com/bholloway/resolve-url-loader). In common case you don't have to do anything special to apply it — we are doing it internally (just don't forget to install it). But if you want to use its custom settings, please provide it explicitly via `styleLoaders` option in `.bootstraprc`:
@@ -251,7 +245,6 @@ styleLoaders:
 ```
 
 #### jQuery
-
 If you want to use Bootstrap's JS scripts — you have to provide `jQuery` to Bootstrap JS modules using `imports-loader`:
 
 ```js
@@ -269,7 +262,6 @@ module: {
 ```
 
 #### Icon fonts
-
 Bootstrap uses **icon fonts**. If you want to load them, don't forget to setup `url-loader` or `file-loader` in webpack config:
 
 ```js
@@ -281,21 +273,22 @@ module: {
 },
 ```
 
-## License
+## Contributing
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](CODE_OF_CONDUCT.md).
 
-MIT.
+See [Contributing](CONTRIBUTING.md) to get started.
 
-## Example and Related Libraries:
+## License
+MIT.
 
+## Example and Related Libraries
 * [react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/), live example at [www.reactrails.com](http://www.reactrails.com/).
 * [sass-resources-loader](https://github.com/shakacode/sass-resources-loader/)
 * [Simple integration example](./examples/basic)
 * [React + hot reloading example: bootstrap-loader-css-modules-example](./examples/css-modules)
 
 ## Useful Q&A
-
 * [Using CSS modules with Bootstrap](https://github.com/shakacode/bootstrap-loader/issues/9)
 * [How would you use bootstrap styles to build css module styles](https://github.com/shakacode/bootstrap-loader/issues/12)
 
 We'll identify issues that are [questions](https://github.com/shakacode/bootstrap-loader/issues?utf8=%E2%9C%93&q=is%3Aissue+label%3Aquestion).
-