Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.9 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 2.9 KB

Contributing to Rclone Docker with WebUI, AutoMount, and Sync

Thank you for considering contributing to this project! We welcome contributions from the community to help improve and enhance the functionality of this repository. Please take a moment to review these guidelines before you start contributing.

How to Contribute

Reporting Issues

If you encounter any issues or bugs, please report them by creating a new issue in the GitHub Issues section. When reporting an issue, please provide as much detail as possible, including:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Any relevant logs or error messages
  • Your environment (e.g., operating system, Docker version)

Feature Requests

If you have an idea for a new feature or improvement, please open a new issue in the GitHub Issues section and label it as a "Feature Request." Provide a detailed description of the feature, including its purpose and how it would benefit users.

Pull Requests

We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Create a new branch from the main branch with a descriptive name (e.g., feature/new-feature or bugfix/issue-123).
  3. Make your changes in the new branch.
  4. Ensure your code follows the project's coding style and conventions.
  5. Write clear and concise commit messages.
  6. Test your changes thoroughly.
  7. Push your changes to your forked repository.
  8. Open a pull request against the main branch of the original repository.

Code Style

Please follow these coding style guidelines when contributing to the project:

  • Use consistent indentation (4 spaces).
  • Write clear and concise comments to explain the purpose of your code.
  • Follow the existing code structure and naming conventions.
  • Ensure your code is well-organized and easy to read.

Testing

Before submitting a pull request, make sure to test your changes thoroughly. This includes:

  • Running the container and verifying that it works as expected.
  • Testing any new features or bug fixes.
  • Checking for any regressions or unintended side effects.

Documentation

If your contribution includes new features or changes to existing functionality, please update the documentation accordingly. This includes:

  • Updating the README.md file with any new instructions or information.
  • Adding comments to your code to explain its purpose and usage.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Code of Conduct

We expect all contributors to adhere to the Code of Conduct to ensure a welcoming and inclusive environment for everyone.

Thank you for your contributions and support!