From 423cbd737ea4b5b385722e228bd148e22710d54e Mon Sep 17 00:00:00 2001 From: Christopher McCulloh Date: Tue, 13 Sep 2016 17:38:56 -0400 Subject: [PATCH] () consolidates CONTRIBUTING guidelines and brings inline with SLDS --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 26 ++------------------------ 2 files changed, 43 insertions(+), 24 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..87684012d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +### Before writing code +1. [confirm issue is new](https://github.com/ExactTarget/fuelux/issues) + - if not, get involved in previous report of issue +1. [create a new issue](https://github.com/ExactTarget/fuelux/issues/new) + - this way, we can give feedback/direction as early as possible to ensure the most successful outcome for your hard work + +### Writing code +* do not edit or commit files in the `dist` directory + - project maintainers will commit files in the `dist` directory from time to time + - details on compiling CSS and JavasScript can be found [here](https://github.com/exacttarget/fuelux/blob/master/DETAILS.md#compiling-code) +* source files are in respective `js`, `less`, and `fonts` directories +* conform to [Salesforce Marketing Cloud style guide](https://github.com/ExactTarget/javascript) +* if you are new to git, please review [our git commit conventions](https://github.com/ExactTarget/fuelux/wiki/Fuel-UX-Git-and-GitHub-Conventions) + + +1. [fork this repository](https://github.com/ExactTarget/fuelux/fork) +2. clone locally +3. `npm install` +4. create new branch, named after the GH Issue you are resolving +5. add unit tests for new or changed functionality + - unit tests are found in `/test` +5. make your changes +6. `grunt test` to lint and unit test your changes +7. `grunt servefast` and visit `http://localhost:8000/test/` for information on failing unit tests +1. [sync your fork](https://help.github.com/articles/syncing-a-fork/) with the upstream repo +1. commit your changes + - **do not commit files within ````/dist````** + - commit unit tests and code separately, unit tests first so we can see them fail and then pass + - write meaningful commit messages (NO WIP!) + +### Submitting Pull Requests +All pull requests are validated via [Travis CI](https://travis-ci.org/). If the tests fail and you feel it is a Travis issue, you can [trigger a restart](https://github.com/exacttarget/fuelux/blob/master/DETAILS.md#travis-ci). + +While grunt can run the included unit tests via PhantomJS, this isn't a substitute for running tests across a variety of browsers and environments. Please be sure to test in as many of the browsers listed in `sauce_browsers.yml` as you can before contributing. + +1. run `grunt test` to lint & test your code +1. if necessary, rebase and squash to as few commits as practical +1. push to your forked repo +1. submit a pull request to master +- for help, visit GitHub's [using pull requests](https://help.github.com/articles/using-pull-requests) +1. Follow your pull request answering questions and making adjustments as appropriate until it is merged diff --git a/README.md b/README.md index 9fd5c4c95..bdadb235c 100644 --- a/README.md +++ b/README.md @@ -95,30 +95,8 @@ Fuel UX documentation is built with [Jekyll](http://jekyllrb.com) and publicly h [Documentation for v2.6](http://getfuelux.com/2.6/) has been made available for the time being while folks transition to Bootstrap 3. You can download 2.6 updates (bug fixes only) from the [fuelux2 branch](https://github.com/ExactTarget/fuelux/tree/fuelux2). ## Contributing -### Before writing code -* [confirm issue is new](https://github.com/ExactTarget/fuelux/issues), if not, get involved in previous report of issue. -* [create a new issue](https://github.com/ExactTarget/fuelux/issues/new) to confirm where your contribution fits into -our roadmap. - -### Writing code -* Do not edit or commit files in the `dist` directory. *Project maintainers will commit files in the `dist` directory from time to time. Details on compiling CSS and JavasScript can be found [here](https://github.com/exacttarget/fuelux/blob/master/DETAILS.md#compiling-code).* -* Source files are in respective `js`, `less`, and `fonts` directories. -* Conform to [Salesforce Marketing Cloud style guide](https://github.com/ExactTarget/javascript). -* Add and/or update unit tests for any new or changed functionality. -* Test your code at [http://localhost:8000/](http://localhost:8000/). (start using `grunt servefast`) -* Run unit tests with `grunt test` or in browser at [http://localhost:8000/test/](http://localhost:8000/test/) (you'll need to `grunt servefast` to keep server from quitting on failed unit tests to troubleshoot in browser). - -### Submitting Pull Requests -All pull requests are validated via [Travis CI](https://travis-ci.org/). If the tests fail and you feel it is a Travis issue, you can [trigger a restart](https://github.com/exacttarget/fuelux/blob/master/DETAILS.md#travis-ci). - -While grunt can run the included unit tests via PhantomJS, this isn't a substitute for running tests across a variety of browsers and environments. Please be sure to test in as many of the browsers listed in `sauce_browsers.yml` as you can before contributing. - -* Run `grunt` to lint & test your code. -* Write meaningful commit messages. -* Submit a pull request from your github fork, mentioning the issue your changes fix. -* Follow your pull request answering questions and making adjustments as appropriate until it is merged. - -Read more about [contributing to FuelUX](https://github.com/ExactTarget/fuelux/wiki/Contributing-to-Fuel-UX) + +Please read the [CONTRIBUTING.md](CONTRIBUTING.md) first. ## Community