Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
104 lines (71 loc) · 5.12 KB

CONTRIBUTING.md

File metadata and controls

104 lines (71 loc) · 5.12 KB

Contributing

This plugin is designed to make it easier for multiple developers to implement their own features.

How to contribute

Contribution Details
Report a bug You can file an issue To report a bug.
Contribute code You can contribute your code by fixing a bug or implementing a feature.
Help to translate You can help translate the plugin from .
Help in discord There are many users asking for help on discord. Coding Channel in the official Discord

Contribute Code

To contribute code, please use the fork-and-pull workflow. This makes it easy for anyone to propose changes without needing write access to the main repository. All contributions will be reviewed and must follow DarkBot's rules.

Step-by-step guide

  1. Create a fork
  • On GitHub, click the "Fork" button in the top-right corner of the repository page to create a copy under your account.

Note: You only need to create a fork the first time you contribute. If you already have a fork, skip this step and clone or update your existing fork.

  1. Clone your fork
  • If you already have a fork and cloned it previously, first sync your fork on GitHub with the upstream repository (recommended), then update your local clone.

On GitHub: open your fork page → click "Sync fork" → "Update branch".

# after syncing your fork on GitHub (Sync fork → Update branch):
git checkout main
git fetch origin
git pull --rebase origin main
  • Otherwise, clone your fork with:
git clone git@github.com:<your-username>/SharedPlugin.git
cd SharedPlugin
  1. Create a branch in your fork
git checkout -b my-feature-branch
  1. Add your code and test it
  • Implement your changes and run any local tests or manual checks.
  • This plugin depends on DarkBotAPI and DarkBot. Prefer using DarkBotAPI instead of referencing DarkBot directly.
  1. Push your branch to your fork
git add .
git commit -m "Short, descriptive message"
git push -u origin my-feature-branch
  1. Make a Pull Request to the main repository
  • On GitHub, open a Pull Request from your fork/branch to the main repository's main branch (or the branch indicated in the repo). Describe what your change does and link any related issues.

Notes

  • Follow repository coding conventions and keep changes focused and small when possible.
  • If your PR requires special testing steps, include them in the PR description so reviewers can reproduce.

Code guidelines

  • Follow Clean Code principles and keep classes and methods focused on a single responsibility.
  • Use clear naming conventions: PascalCase for classes, camelCase for methods and variables, and UPPER_CASE_WITH_UNDERSCORES for constants.
  • Keep one public class per file and match the filename to the public class name.
  • Prefer defensive programming and avoid null where possible.
  • Catch specific exception types and include meaningful context when handling errors.
  • Use try-with-resources for AutoCloseable resources.
  • Choose collections according to usage patterns (for example, ArrayList for indexed access and HashMap for key-based lookups).
  • Avoid unnecessary static state and utility methods when instance-based design is more appropriate.
  • Wherever possible, please use the DarkBotAPI implementation; direct use of DarkBot will be subject to closer scrutiny and may be rejected

Build the plugin

As I use graddle you can run the task 'copyFile' and it will generate a jar called SharedPlugin.jar.

How to test the changes

When a pull request is made, I will build a version with the changes so that they can be tested. Each time a merge is performed, a new version will be deployed and the .jar file will be added.

Rules

  • Rules that violate Darkbot's own rules will not be accepted.
  • Features that include requests to external URLs will not be accepted.
  • Obfuscated features will not be accepted.
  • Features that become obsolete will be disabled until they are updated.
  • The creator of a feature can decide to remove their feature from the plugin at any time, but this will not delete the code or versions that have already been published.
  • Features that are not created by the developer will not be accepted. No copying features from other plugins.
  • Minimum code quality must be maintained.
  • The repository maintainer(s) may delete a feature at any time if it does not comply with the rules.