From ce197cde74c6c76f9fdcbb5c7899761f732bbe43 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torstein=20H=C3=B8nsi?= Date: Wed, 9 Dec 2015 08:00:07 +0100 Subject: [PATCH] Some cleanup in markdown files --- build.md | 75 ---------------------------------------------- readme.md | 26 +--------------- repo-guidelines.md | 27 +++++++++++++++++ 3 files changed, 28 insertions(+), 100 deletions(-) delete mode 100644 build.md create mode 100644 repo-guidelines.md diff --git a/build.md b/build.md deleted file mode 100644 index 38520e2b940..00000000000 --- a/build.md +++ /dev/null @@ -1,75 +0,0 @@ -Building highcharts -=================== - -Prerequisites -------------- - -1. First you will need to have the Git Bash shell installed, follow the instructions found here [msysgit](https://code.google.com/p/msysgit/). -2. We use `ant` to build the source so you also need to have java installed. [java jdk](http://java.oracle.com). -Don't forget to set the JAVA_HOME environment variable to point to the location where java is installed (eg: `C:\Program Files\Java\jdk1.6.0_24`) -3. When git and java is in place, clone the highcharts repository by running `git clone git://github.com/highslide-software/highcharts.git`. - -Build system ------------- - -Highcharts is built from the command line and all build tasks are run from the top folder in the source tree, so first cd to the cloned repository: -`$ cd highcharts` - -To make sure that `ant` is installed correctly, just type: -`$ ant -version` -It should respond with version number and build date. - -### assemble -Running `$ ant assemble` will concatenate the parts into one file `highcharts.src.js`. This file is -a generated file so don't edit it directly. We keep the assembled file in github so to be able to -directly reference it from jsFiddle. E.g: -`https://raw.github.com/highslide-software/highcharts.com/v2.1.6/js/highcharts.src.js` -will get you the 2.1.6 release. - -### lint -Running `$ ant lint` will do a lint-check of the source. We follow jslint's rules as much as we can, -but there is still a few "bad" parts that are tolerated. Those are noted as general exceptions to -jslint in the build file or inlined in the source. - -### build -To build minified versions of the source you run `$ ant build`. This step will first assemble the -parts then do lint and then minify the source. Both Google Closure Compliler and YUI compressor are -used here, but YUI compressor is only used as an extra validation step. - -Running unit tests ------------------- - -We use js-test-driver from Google as unit test runner. It is quite easy to use and allows for simple -testing in various browsers. Read more here [js-test-driver](http://code.google.com/p/js-test-driver/wiki/GettingStarted). - -The test driver server is started by `$ ant server`, this small web-server opens at -[localhost port 4224](http://localhost:4224). Then start the browsers you would like to run the -tests in and click `capture`. - -Next, running `$ ant test` will run the unit tests in the captured browsers. This setup uses the built-in -jquery adapter when running the tests and also use the latest jquery release. If you want to run tests -with mootools and prototype adapters and across various releases, run `$ ant test-all` - -### Running unit tests with code-coverage - -It is possible to collect coverage data at the same time as running tests. The coverage report is used -to see which lines in the code are tested and which is not. - -To start the js-test-driver in coverage mode, run `$ ant server-coverage`. It will open on port 5225. Then capture -a browser and run `$ ant test-coverage` to execute the tests and `$ ant test-report` to build a test report. - -Repository layout ------------------ - -* js - The javascript sources -* test - The tests -* lib - Libraries needed to build highcharts -* tools - Tools used during building -* studies - Small examples or studies thats not really in the core product - -Source branches ---------------- - -* master - Contains the main branch for highcharts. -* stock2 - Development branch containing highstock product. -* android - Development branch for adding support for older android versions that do not use SVG. diff --git a/readme.md b/readme.md index 9b9e81b8131..8f8ba165cc0 100644 --- a/readme.md +++ b/readme.md @@ -6,6 +6,7 @@ _For NPM users, please note that this module replaces the previous [Highcharts S * Download page: [www.highcharts.com/download](http://www.highcharts.com/download) * Licensing: [www.highcharts.com/license](http://www.highcharts.com/license) * Support: [www.highcharts.com/support](http://www.highcharts.com/support) +* Issues [Repo guidelines](repo-guidelines.md) ## Example Usage in Node/Browserify/Webpack Please note that this is only one way to use Highcharts. For general installation instructions, see [the docs](http://www.highcharts.com/docs/getting-started/installation). @@ -29,28 +30,3 @@ var chart = new Highcharts.Chart({ }); ``` -## Reporting issues -We use GitHub Issues as our official bug tracker. We strive to keep this a clean, maintainable and searchable record of our open and closed bugs, therefore we kindly ask you to obey some rules before reporting an issue: - -1. Make sure the report is accompanied by a reproducible demo. The ideal demo is created by forking [our standard jsFiddle](http://jsfiddle.net/highcharts/llexl/), adding your own code and stripping it down to an absolute minimum needed to demonstrate the bug. -* Always add information on what browser it applies to, and other information needed for us to debug. -* It may be that the bug is already fixed. Try your chart with our latest work from http://github.highcharts.com/master/highcharts.js before reporting. -* For feature requests, tech support and general discussion, don't use GitHub Issues. See [www.highcharts.com/support](http://www.highcharts.com/support) for the appropriate channels. - -## Apply a fix -When an issue is resolved, we commit a fix and mark the issue closed. This doesn't mean that a new release is available with the fix applied, but that it is fixed in the development code and will be added to the next stable release. Stable versions are typically released every 1-3 months. To try out the fix immediately, you can run http://github.highcharts.com/highcharts.js or http://github.highcharts.com/highstock.js from any website, but do not use these URLs in production. - -If the fix is critical for your project, we recommend that you apply the fix to the latest stable release of Highcharts or Highstock instead of running the latest file found on GitHub, where other untested changes are also present. Most issues are resolved in single patches that don't conflict with other changes. If you're not into Git and don't want to install and learn that procedure, here's how to apply it quickly with help of online tools: -* Locate your issue on GitHub, for example [#2510](https://github.com/highslide-software/highcharts.com/issues/2510). -* Most issues are closed directly from a commit. Go to that commit, for example [d5e176](https://github.com/highslide-software/highcharts.com/commit/d5e176b5c01bb60402c1f6347993a818e2ab4035). -* Now add `.patch` to the URL to view the [patch file](https://github.com/highslide-software/highcharts.com/commit/d5e176b5c01bb60402c1f6347993a818e2ab4035.patch). -* The patch file will show diffs from all files changed. Here it's important to be aware that `highcharts.src.js`, `highstock.src.js` and `highcharts-more.src.js` are concatenated from parts files. Instead of applying the patches from part files, you only need those from the concatenated files. -* If you need to patch `highcharts.src.js`, copy the diff for that file. Start selecting including the line `diff --git a/js/highcharts.src.js b/js/highcharts.src.js` and select all text until the next diff statement for the next file. -* Now the patch is on your clipboard, open another tab at [i-tools.org/diff](http://i-tools.org/diff). -* Under "Original file", click "By URL" and enter `http://code.highcharts.com/highcharts.src.js` or another source file from the latest stable release, see [code.highcharts.com](http://code.highcharts.com). -* Under "Second file or patch file" click "Direct input" and paste the diff from your clipboard. -* Click the "Patch" button, and if everything is okay you should now have a patched file. -* The next (optional) step is to compile the source code in order to reduce file size. Copy the result from the patched file. -* Go to the [Closure Compiler web app](http://closure-compiler.appspot.com/home). -* Paste the patched file contents to the left and click "Compile". - diff --git a/repo-guidelines.md b/repo-guidelines.md new file mode 100644 index 00000000000..956c15faa06 --- /dev/null +++ b/repo-guidelines.md @@ -0,0 +1,27 @@ + +# Repo guidelines + +## Reporting issues +We use GitHub Issues as our official bug tracker. We strive to keep this a clean, maintainable and searchable record of our open and closed bugs, therefore we kindly ask you to obey some rules before reporting an issue: + +1. Make sure the report is accompanied by a reproducible demo. The ideal demo is created by forking [our standard jsFiddle](http://jsfiddle.net/highcharts/llexl/), adding your own code and stripping it down to an absolute minimum needed to demonstrate the bug. +2. Always add information on what browser it applies to, and other information needed for us to debug. +3. It may be that the bug is already fixed. Try your chart with our latest work from http://github.highcharts.com/master/highcharts.js before reporting. +4. For feature requests, tech support and general discussion, don't use GitHub Issues. See [www.highcharts.com/support](http://www.highcharts.com/support) for the appropriate channels. + +## Apply a fix +When an issue is resolved, we commit a fix and mark the issue closed. This doesn't mean that a new release is available with the fix applied, but that it is fixed in the development code and will be added to the next stable release. Stable versions are typically released every 1-3 months. To try out the fix immediately, you can run http://github.highcharts.com/highcharts.js or http://github.highcharts.com/highstock.js from any website, but do not use these URLs in production. + +If the fix is critical for your project, we recommend that you apply the fix to the latest stable release of Highcharts or Highstock instead of running the latest file found on GitHub, where other untested changes are also present. Most issues are resolved in single patches that don't conflict with other changes. If you're not into Git and don't want to install and learn that procedure, here's how to apply it quickly with help of online tools: +* Locate your issue on GitHub, for example [#2510](https://github.com/highslide-software/highcharts.com/issues/2510). +* Most issues are closed directly from a commit. Go to that commit, for example [d5e176](https://github.com/highslide-software/highcharts.com/commit/d5e176b5c01bb60402c1f6347993a818e2ab4035). +* Now add `.patch` to the URL to view the [patch file](https://github.com/highslide-software/highcharts.com/commit/d5e176b5c01bb60402c1f6347993a818e2ab4035.patch). +* The patch file will show diffs from all files changed. Here it's important to be aware that `highcharts.src.js`, `highstock.src.js` and `highcharts-more.src.js` are concatenated from parts files. Instead of applying the patches from part files, you only need those from the concatenated files. +* If you need to patch `highcharts.src.js`, copy the diff for that file. Start selecting including the line `diff --git a/js/highcharts.src.js b/js/highcharts.src.js` and select all text until the next diff statement for the next file. +* Now the patch is on your clipboard, open another tab at [i-tools.org/diff](http://i-tools.org/diff). +* Under "Original file", click "By URL" and enter `http://code.highcharts.com/highcharts.src.js` or another source file from the latest stable release, see [code.highcharts.com](http://code.highcharts.com). +* Under "Second file or patch file" click "Direct input" and paste the diff from your clipboard. +* Click the "Patch" button, and if everything is okay you should now have a patched file. +* The next (optional) step is to compile the source code in order to reduce file size. Copy the result from the patched file. +* Go to the [Closure Compiler web app](http://closure-compiler.appspot.com/home). +* Paste the patched file contents to the left and click "Compile". \ No newline at end of file