Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 2.88 KB

README.md

File metadata and controls

73 lines (47 loc) · 2.88 KB
Raw

Demonology

An incremental game about souls harvesting and growing evil.

Contributing to Demonology

Demonology is a a personal project and I work on it on my spare time. I am not willing nor able to dedicate much time on the project. I will not implement and maintain complex features if I'm not going to use them myself or if I think they are out of scope for the project.

With that in mind, I will gladly accept bug reports, feature requests, pull requests and other contributions. I will also respectfully decline contributions I cannot or do not want to handle for the reasons stated above.

Community and contribution rules

If you're playing Demonology or use one of the community spaces such as the GitHub issues, discussions or any other discussion space, you are expected to comply with our Code of Conduct.

This Code of Conduct is non-negotiable and I will gladly enforce it. You can also contact me at [email protected] if you think some moderation action needs to be taken.

Software license

Demonology is licensed under GNU Affero General Public License v3.0.

Reporting bugs

If you encounter a bug while playing Demonology, you're welcome to open an issue. Please have a quick look at the issue tracker beforehand, as someone may already have reported it.

Include as much context as applicable and possible, in particular:

  • Browser name and version
  • Operating system name and version
  • Steps to reproduce the issue (if you found a way to reproduce it)
  • Screenshots (in particular if the issue is related to the user interface)

Requesting features or enhancements

If you'd like to see a new feature or enhancement in Demonology, you're welcome to open an issue. Please have a quick look at the issue tracker beforehand, as someone may already have asked for it.

Include as much context as applicable and possible regarding the use case or the problem you want solved.

Submitting merge requests

If you want to fix a bug, a typo, or implement a new feature or enhancement, please do! I will happily review and merge your contribution unless it doesn't meet the criteria described above in the "Contributing to Demonology" section.

If your contribution is a sizeable enhancement or new feature, I strongly recommend you start a discussion before beginning to work on it

Run Demonology locally

Project setup

yarn install

Compiles and hot-reloads for development

yarn serve

Compiles and minifies for production

yarn build

Run your unit tests

yarn test:unit

Lints and fixes files

yarn lint