Skip to content

Latest commit

 

History

History
32 lines (28 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

32 lines (28 loc) · 1.61 KB

Contributing

You can add yourself to the contributors in src/main/resources/plugin.yml when you make your first contribution.

If you contribute to this project, you agree to abide by the code of conduct. Please read the guidelines below before contributing.

Best Practice

  1. Fork the Repository: Fork the repository to your GitHub account.
  2. Create a New Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/my-feature
  1. Write Clean Code: Ensure your code follows the project's coding standards and conventions.
  2. Write Tests: Write tests for your code. We use JUnit for unit testing, and the plugin can be tested against a real Minecraft server.
  3. Commit Changes: Commit your changes and write meaningful commit messages.
git commit -m "Add feature: My new feature"
  1. Push Changes: Push your changes to your forked repository.
git push origin feature/my-feature
  1. Create a Pull Request: Create a pull request from your branch to the main repository. Describe the changes you have made and why they are beneficial.

Best Practices

  • Code Style: Follow the project's code style and conventions.
  • Testing: Write tests for your code to ensure it works as expected.
  • Documentation: Document your code and any changes you make.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or suggestions, feel free to contact me at [email protected]