Updated contributing guide etc.

This commit is contained in:
Steve Gravrock
2021-04-17 11:53:06 -07:00
parent 82cc1083b6
commit 316ce1e2d3
3 changed files with 16 additions and 10 deletions

View File

@@ -56,15 +56,15 @@ Jasmine supports the following environments:
* Browsers * Browsers
* IE10+ * IE10+
* Edge Latest * Edge latest
* Firefox Latest * Firefox latest, 78, and 68
* Chrome Latest * Chrome latest
* Safari 8+ * Safari 8+
* Node.js * Node.js
* 8
* 10 * 10
* 12 * 12
* 14
## Development ## Development
@@ -99,11 +99,18 @@ Follow these tips and your pull request, patch, or suggestion is much more likel
### Running Specs ### Running Specs
Jasmine uses some internal tooling to test itself in browser on Circle CI. This tooling _should_ work locally as well. Be sure to run the tests in at least one supported Node version and at least a
couple of supported browsers. It's also a good idea to run the tests in Internet
Explorer if you've touched code in `src/html`, if your change involves newer
JavaScript language/runtime features, or if you're unfamiliar with writing code
for older browsers. To run the tests in Node, simply use `npm test` as described
above. To run the tests in a browser, run `npm run serve` and then visit
`http://localhost:8888`.
$ node spec/support/ci.js If you have the necessary Selenium drivers installed, you can also use Jasmine's
CI tooling:
You can also set the `JASMINE_BROWSER` environment variable to specify which browser should be used. $ JASMINE_BROWSER=<name of browser> node spec/support/ci.js
The easiest way to run the tests in **Internet Explorer** is to run a VM that has IE installed. It's easy to do this with VirtualBox. The easiest way to run the tests in **Internet Explorer** is to run a VM that has IE installed. It's easy to do this with VirtualBox.
@@ -112,7 +119,7 @@ The easiest way to run the tests in **Internet Explorer** is to run a VM that ha
1. Unzip the downloaded archive. There should be an OVA file inside. 1. Unzip the downloaded archive. There should be an OVA file inside.
1. In VirtualBox, choose `File > Import Appliance` and select the OVA file. Accept the default settings in the dialog that appears. Now you have a Windows VM! 1. In VirtualBox, choose `File > Import Appliance` and select the OVA file. Accept the default settings in the dialog that appears. Now you have a Windows VM!
1. Run the VM and start IE. 1. Run the VM and start IE.
1. With `npm run serve` running on your host machine, navigate to `http://10.0.2.2:8888` in IE. 1. With `npm run serve` running on your host machine, navigate to `http://<your IP address>:8888` in IE.
## Before Committing or Submitting a Pull Request ## Before Committing or Submitting a Pull Request

View File

@@ -11,8 +11,6 @@ Jasmine is a Behavior Driven Development testing framework for JavaScript. It do
Documentation & guides live here: [http://jasmine.github.io](http://jasmine.github.io/) Documentation & guides live here: [http://jasmine.github.io](http://jasmine.github.io/)
For a quick start guide of Jasmine, see the beginning of [http://jasmine.github.io/edge/introduction.html](http://jasmine.github.io/edge/introduction.html). For a quick start guide of Jasmine, see the beginning of [http://jasmine.github.io/edge/introduction.html](http://jasmine.github.io/edge/introduction.html).
Upgrading from Jasmine 2.x? Check out the [3.0 release notes](https://github.com/jasmine/jasmine/blob/v3.0.0/release_notes/3.0.md) for a list of what's new (including breaking changes).
## Contributing ## Contributing
Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/main/.github/CONTRIBUTING.md). Please read the [contributors' guide](https://github.com/jasmine/jasmine/blob/main/.github/CONTRIBUTING.md).

View File

@@ -35,6 +35,7 @@ When ready to release - specs are all green and the stories are done:
### Commit and push core changes ### Commit and push core changes
1. Run the browser tests using `scripts/run-all-browsers`.
1. Commit release notes and version changes (jasmine.js, version.rb, package.json) 1. Commit release notes and version changes (jasmine.js, version.rb, package.json)
1. Push 1. Push
1. Wait for Circle CI to go green 1. Wait for Circle CI to go green