Skip to content

Latest commit

 

History

History
88 lines (54 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

88 lines (54 loc) · 3.67 KB
Raw

Contributing to WorkAdventure

Are you looking to help on WorkAdventure? Awesome, feel welcome and read the following sections in order to know how to ask questions and how to work on something.

Contributions we are seeking

We love to receive contributions from our community — you!

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into WorkAdventure itself.

Contributing external resources

You can share your work on maps / articles / videos related to WorkAdventure on our awesome-workadventure list.

Developer documentation

Documentation targeted at developers can be found in the /docs/dev

Using the issue tracker

First things first: Do NOT report security vulnerabilities in public issues!. Please read the security guide to learn who to do a security disclosure to the WorkAdventure core team.

You can use GitHub issue tracker to:

  • File bug reports
  • Ask for feature requests

If you have more general questions, a good place to ask is our Discord server.

Finally, you can come and talk to the WorkAdventure core team... on WorkAdventure, of course! Our offices are here.

Pull requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

You can ask us on Discord or in the GitHub issues.

Linting your code

Before committing, be sure to install the "Prettier" precommit hook that will reformat your code to our coding style.

In order to enable the "Prettier" precommit hook, at the root of the project, run:

$ # This install all dependencies
$ npm install
$ # This actually installs the precommit hooks.
$ npm run prepare

If you don't have the precommit hook installed (or if you committed code before installing the precommit hook), you will need to run code linting manually:

$ docker-compose exec play npm run pretty
$ docker-compose exec back npm run pretty

Providing tests

WorkAdventure is based on a video game engine (Phaser), and video games are not the easiest programs to unit test.

Nevertheless, if your code can be unit tested, please provide a unit test (we use Jasmine), or an end-to-end test (we use Playwright).

If you are providing a new feature, you should setup a test map in the maps/tests directory. The test map should contain some description text describing how to test the feature.

  • if the features is meant to be manually tested, you should modify the maps/tests/index.html file to add a reference to your newly created test map
  • if the features can be automatically tested, please provide an end-to-end test

Running end-to-end tests

End-to-end tests are available in the "/tests" directory.

More information on running end-to-end tests can be found in the /tests/README.

A bad wording or a missing language

If you notice a translation error or missing language you can help us by following the how to translate documentation.