Skip to content

Contributing

Contributing to ExVenture

Thanks for being interested in contributing to ExVenture!

Note: any contributions will be licensed under the license used by ExVenture.

Issues

If you have a support question, please ask on the Discord instead of submitting an issue. Issues should be for feature requests or bugs only.

Pull Requests

To start contributing code back to ExVenture follow these steps:

  1. Fork the project to your own account and clone this locally

  2. Check out a feature branch

  3. Work on your change on the feature branch

Important: Be sure to include tests and docs with your new changes. There are many ExUnit examples in the test folder if you need help. Don't hesitate to ask in the Discord chat for help.

  1. Commit in logical chunks

See https://commit.style/ for a commit message style guide.

  1. Push your feature branch to your forked repo.

  2. Submit a pull request!

Be sure to include a clear title and description.