Dominion/CONTRIBUTING.md

1.9 KiB

Contributing to Dominion

Thank you for considering contributing to Dominion! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

🪲Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub repository. Include as much detail as possible, including steps to reproduce the issue, the expected result, and the actual result.

💡Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue on our GitHub repository and describe the enhancement you would like to see, why you think it would be useful, and any other relevant information.

🌐Translating

  1. Fork the repository.
  2. Clone the repository to your local machine.
  3. Create a new branch for your translation.
  4. Translate the documentation or plugin messages.
  5. Commit your changes.
  6. Push your changes to your fork.
  7. Open a pull request.
  8. Wait for your pull request to be reviewed and merged.

Documentation

Documentations are located in the docs directory. Translate the files in the language you want to contribute to.

  • If the language you want to translate to does not exist, create a new directory with the language code (e.g., zh-cn for Simplified Chinese).
  • If the documentation is not up-to-date, please update it from the zh-cn directory.

Plugin Messages

The plugin messages are located in the languages directory. Translate the files in the language you want to contribute to.

  • If the language you want to translate to does not exist, create a new file with the language code (e.g., zh-cn.yml for Simplified Chinese).
  • If the plugin messages are not up-to-date, please update them from the zh-cn.yml file.

🫴Getting Help

If you need help, feel free to ask questions by opening an issue on our GitHub repository.

Thank you for contributing!