Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (56 loc) · 2.79 KB
Raw

Shadow Tool contributing guide

This document contains the basic guidelines to contribute to the Shadow Tool project. If you would like to contribute to the project, this document should help you to get started.

Creating an issue

If you think you found a bug in Shadow Tool, or if you have a nice addition to the project you can start by creating an issue in GitHub. When creating an issue you can follow below steps:

  • To prevent duplicates, check if a similar issue already exists.
  • Clearly describe the issue. If it is a bug provide the steps to reproduce the issue or provide a code example.

Building the project

Requirements

  • Maven
  • Java JDK 11

Building

Compiling and running the tests:

mvn verify

Installing the jar in your local maven repository:

mvn install

Code changes

Getting started

  • Make sure you have a GitHub account.
  • Fork the repository on GitHub.
  • Create an issue if it does not exist already.

Implement your changes

  • Make the necessary changes to the codebase.
  • Write clear and concise commit messages for each logical change you make.
  • Ensure that your code adheres to the project's coding style and guidelines.
  • Run the project's tests to ensure that your changes haven't introduced any new issues. If applicable, write additional tests to cover the changes you've made.

Submitting a pull request

  • Visit the original Shadow Tool repository on GitHub.
  • Click on the "New Pull Request" button.
  • Select your branch from the list of available branches.
  • Provide a descriptive title and description for your pull request.
  • If your pull request addresses any open issues, reference them in the description.
  • Submit the pull request.

Code review and feedback

  • Be responsive to any feedback or comments you receive on your pull request.
  • Address the feedback by making the necessary changes to your code.

Merge process

Once your pull request has received approval from the project maintainers, it will be merged into the main repository.

Congratulations! You've successfully contributed to the Shadow Tool project.

Documentation changes

If you would like to contribute to the project's documentation, you can follow the steps below:

  • Fork the repository on GitHub.
  • Make the necessary changes to the documentation files.
  • Commit your changes with clear and descriptive commit messages.
  • Push your changes to your forked repository.
  • Submit a pull request to the original Shadow Tool repository.

Conclusion

Thank you for considering contributing to the Shadow Tool project! Your contributions are greatly appreciated and help improve the project for everyone. If you have any questions or need further assistance, feel free to reach out to the project maintainers. Happy contributing!