Skip to content

Contributing

fourbones edited this page Jul 14, 2023 · 1 revision

Contributing Guide

We welcome contributions to the Discord Minecraft Whitelist Bot! Whether you have ideas for new features, bug fixes, or general improvements, your contributions can help enhance the bot for the entire community.

To contribute to the project, follow the steps outlined below:

Reporting Issues

If you encounter any issues or have suggestions for improvements, please check the existing issue tracker on GitHub to see if a similar issue has been reported. If not, you can submit a new issue with the following details:

  • A clear and descriptive title.
  • A detailed description of the issue or suggestion.
  • Steps to reproduce the issue (if applicable).
  • Any relevant logs or error messages.

Making Changes

If you'd like to contribute code changes to the project, follow these steps:

  1. Fork the project repository to your GitHub account.
  2. Create a new branch for your changes.
  3. Make your desired changes, adhering to the project's coding style and guidelines.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes with a descriptive commit message.
  6. Push your branch to your forked repository.
  7. Open a pull request in the original repository to propose your changes.

Pull Request Guidelines

When submitting a pull request, please ensure the following:

  • Provide a clear and descriptive title for the pull request.
  • Include a detailed description of the changes made.
  • Reference any related issues in the pull request description using the format "Fixes #issue-number".
  • Ensure that your changes pass all tests and do not introduce any new issues.
  • Be responsive to any feedback or review comments during the pull request review process.

Clone this wiki locally