Skip to content

Commit

Permalink
Docs: Improve readme and contributing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Krinkle committed Jan 26, 2025
1 parent 818eb9d commit daab672
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 38 deletions.
43 changes: 16 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,11 @@

# Contributing

Welcome! Thanks for your interest in contributing to QUnit. This document is
intended to help make your experience smooth and enjoyable. If you feel
anything should be added or clarified, definitely let us know.
Welcome! Thanks for your interest in contributing to QUnit. This document is intended to help make your experience smooth and enjoyable. If you feel anything should be added or clarified, definitely let us know.

If this is your first time contributing to open-source software, you might want
to take a look at the [GitHub Guides](https://guides.github.com/).
If this is your first time contributing to open-source software, you might want to take a look at the [GitHub Guides](https://guides.github.com/).

If you get stuck or need help, you can always [chat with us](https://app.element.io/#/room/#qunitjs_qunit:gitter.im).
If you get stuck or need help, you can always [chat with us](https://qunitjs.com/intro/#support).

## Where to begin

Expand All @@ -23,22 +20,13 @@ good ways to gain familiarity with just one or two areas of the code.
You're also welcome to start on any other [open issue](https://github.com/qunitjs/qunit/issues).
Feel free to comment in that case to ask for directions.

## Contributor License Agreement

As a first step, in order to contribute to QUnit, you will need to sign the JS
Foundation's [CLA for QUnit](https://cla.js.foundation/qunitjs/qunit).

## Code

For code changes, you'll need to have [Node.js](https://nodejs.org/en/) installed.
For code changes, you'll need to have [Node.js](https://nodejs.org/) installed.

Install dependencies in the repository via `npm install`. Make your code
changes and run `npm test` which will validate the syntax and coding style,
and run unit and integration tests.
Install dependencies in the repository via `npm install`. Make your code changes and run `npm test` which will validate the syntax and coding style, and run unit and integration tests.

In general, code changes should be accompanied by a unit test to verify the
change in functionality. Once the new tests are passing, make a commit, push it
to your GitHub fork, and create the pull request.
In general, code changes should be accompanied by a unit test to verify the change in functionality. Once the new tests are passing, make a commit, push it to your GitHub fork, and create the pull request.

## Documentation

Expand All @@ -48,11 +36,9 @@ Check [docs/README.md](docs/README.md) for how to locally preview the API docume

## Commit messages

If you're a new contributor, don't worry if you're unsure about
the commit message. The team will edit or write it for you as part
of their code review and merge activities. If you're a regular
contributor, do try to follow this structure as it helps others to
more quickly find, understand, and merge your changes. Thanks!
If you're a new contributor, don't worry if you're unsure about the commit message.

The team will improve it for you as part of their code review and merge activities. If you're a regular contributor, we appreciate you following this structure as it helps everyone to more quickly understand and review your changes, and to summarise them for the changelog. Thanks!

Structure:

Expand All @@ -62,11 +48,10 @@ Component: Short subject line about what is changing
Additional details about the commit are placed after a new line
in the commit message body. That's this paragraph here.
As well as any additional paragraphs. The last block is the footer,
which is reserved for any "Ref", "Fixes" or "Closes" instructions
(one per line).
The last lines are the footer, which is reserved for any "Ref", "Fixes"
or "Closes" commands (one per line).
Fixes #1.
Fixes https://github.com/qunitjs/qunit/issues/1000.
```

The subject line should use the [imperative mood](https://en.wikipedia.org/wiki/Imperative_mood),
Expand All @@ -82,3 +67,7 @@ and start with one of the following components:
* `Test`

See also [Commit message guidelines](https://www.mediawiki.org/wiki/Gerrit/Commit_message_guidelines).

## Contributor License Agreement

After creating your first pull request, a bot will ask you to sign the JS Foundation's [CLA for QUnit](https://cla.js.foundation/qunitjs/qunit).
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@

</div>

**QUnit** is a powerful, easy-to-use JavaScript testing framework. It was originally developed for the jQuery
project and has since evolved to test any client-side or server-side JavaScript code. QUnit has no dependencies and supports Node.js, SpiderMonkey, and all major web browsers.
**QUnit** is a powerful, easy-to-use JavaScript testing framework. It was originally developed for the jQuery project and has since evolved to test any client-side or server-side JavaScript code. QUnit has no dependencies and supports all major desktop and mobile web browsers, Node.js, and SpiderMonkey.

## Documentation

Expand All @@ -25,7 +24,7 @@ project and has since evolved to test any client-side or server-side JavaScript

To report a bug or request a new feature, [open an issue](https://github.com/qunitjs/qunit/issues).

If you need help using QUnit, chat with us on [Matrix](https://app.element.io/#/room/#qunitjs_qunit:gitter.im).
If you get stuck or need help, [join the chat room](https://qunitjs.com/intro/#support) and ask us a question.

## Contribute

Expand Down
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* [Assertions](./api/assert/)
* [Callback events](./api/callbacks/)
* [Configuration options](./api/config/)
* [Reporters](./api/reporters/)
* [Extension interface](./api/extension/)

## Contribute
Expand All @@ -20,14 +21,14 @@ Prerequisites:
* [Ruby](https://www.ruby-lang.org/) 2.7 or later. Install from Apt on Linux, or [Homebrew](https://brew.sh/) on macOS.
* [Bundler](https://bundler.io/), e.g. `gem install bundler`.

To regenerate the site and serve locally at <http://localhost:4000/>.
To regenerate the site and serve locally at <http://localhost:4000/>:

```shell
cd qunit/docs/
bundle update && bundle exec jekyll serve
```

This will start the server in watch mode and regenerate the site as-needed.
This will start the server in watch mode and regenerate the site on-the-fly.

### Update plugins page

Expand Down
9 changes: 4 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,11 @@ These are the official [release channels](intro.md#download) for QUnit:

## Join the Community

<p class="lead lead--center" markdown="1">Join us on [Mastodon](https://fosstodon.org/@qunit), [Bluesky](https://bsky.app/profile/qunitjs.com), or [Matrix chat](./intro.md#support).</p>
<p class="lead" markdown="1">Follow us on [Mastodon](https://fosstodon.org/@qunit) or [Bluesky](https://bsky.app/profile/qunitjs.com)</p>

To contribute:

* [Watch the repository](https://github.com/qunitjs/qunit) to learn about release, new requests, or bug reports.
* The source of this website, is in the ["docs/" directory](https://github.com/qunitjs/qunit/tree/main/docs).
* [Support & Chat](./intro.md#support), for if you get stuck or need help.
* [Watch the repository](https://github.com/qunitjs/qunit), to find out about new release.
* The source of this website is in the ["docs/" directory](https://github.com/qunitjs/qunit/tree/main/docs).

---

Expand Down
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ You can also find support on StackOverflow. Use the ["qunit" hashtag on StackOve

## Chat

If you need help, join us in our chat room on Matrix at `#qunitjs_qunit:gitter.im`:
If you need help, or want to participate in sharing and discussing ideas, join us in the chat room on Matrix at `#qunitjs_qunit:gitter.im`:

* **[Gitter web client](https://app.gitter.im/#/room/#qunitjs_qunit:gitter.im)**, browse the room as guest.
* [Element web client](https://app.element.io/#/room/#qunitjs_qunit:gitter.im), join and log in (with GitHub, GitLab, Google, or Apple ID), or sign up.
Expand Down

0 comments on commit daab672

Please sign in to comment.