Skip to content

Latest commit

 

History

History
99 lines (60 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

99 lines (60 loc) · 3.42 KB
Raw

Contributing Guidelines

Thank you for considering contributing to this Minecraft plugin! By contributing, you help make this project better for everyone. We appreciate your time and effort.

Getting Started

Before you start contributing, please ensure you have read and understood our Code of Conduct. Make sure your contributions align with the project's goals and standards.

Setting Up the Development Environment

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Set up your development environment according to the provided instructions in the project documentation.

How to Contribute

We welcome contributions in the form of bug reports, feature requests, code improvements, and more. Here are some guidelines to help you get started:

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue on GitHub. Provide detailed information about the problem or suggestion, including steps to reproduce if applicable.

Code Contributions

  1. Branching: Create a new branch for your contribution. Use a descriptive branch name. 
    git checkout -b feature/new-feature

Code Style

  1. Consistency: Follow the existing coding style and conventions used in the project. Consistent code makes it easier to read and maintain.

  2. Indentation: Use spaces for indentation, and maintain a consistent number of spaces (e.g., 2 or 4 spaces).

  3. Naming Conventions: Choose meaningful and descriptive names for variables, functions, and classes. Follow common naming conventions in the language you are using.

  4. Comments: Include comments where necessary to explain complex sections of code or to provide context. However, strive to write code that is self-explanatory.

  5. Formatting: Keep code formatting consistent. Use tools like linters or formatters if available for your development environment.

  6. Documentation: Document your code, especially public APIs. Provide information about the purpose of functions, expected inputs, and return values.

Testing

  1. Unit Tests: Write unit tests for your code. Ensure that your changes pass existing tests and consider adding new tests to cover additional cases.

  2. Integration Tests: If applicable, include integration tests that cover the interaction of your code with other parts of the system.

  3. Test Coverage: Aim for high test coverage to catch potential issues early in the development process.

Pull Requests

  1. Base Branch: Submit your pull request to the appropriate branch (usually main or master).

  2. Description: Provide a clear and concise description of your changes in the pull request.

  3. Review: Your pull request will be reviewed by maintainers. Be responsive to feedback and make necessary adjustments.

  4. Continuous Integration: Ensure that your changes pass the continuous integration tests if available.

Security

Please review our Security Policy for information on reporting vulnerabilities and our process for handling them.

Code of Conduct

Help us keep a positive and inclusive community. See our Code of Conduct for details.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing to this Minecraft plugin!