Contributing to wandR
We welcome contributions to the wandR package! Whether you’re looking to report a bug, suggest an enhancement, or contribute code, your help is appreciated. This document provides guidelines for contributing to wandR.
Reporting Issues
Before reporting an issue, please do the following: - Check the issue tracker to ensure the issue hasn’t already been reported. - Update to the latest version of wandR to see if the issue has been fixed.
When reporting an issue, please include: - A clear and descriptive title. - A detailed description of the problem, including any error messages. - Steps to reproduce the issue. - The expected behavior versus what you observed.
Suggesting Enhancements
We’re always looking for suggestions to improve wandR! Enhancement suggestions are tracked as GitHub issues. When suggesting an enhancement, include: - A clear and descriptive title. - A detailed explanation of the proposed feature or improvement. - Any examples of how the enhancement would be used.
Pull Requests
If you’re looking to contribute code, here’s how to get started: 1. Fork the repository on GitHub and clone your fork locally. 2. Install the package locally and ensure it builds correctly. 3. Create a new branch for your contribution. 4. Make your changes. Keep your code as clean and clear as possible. 5. Test your changes. Ensure that your changes do not break any existing functionality. 6. Commit your changes. Use clear and descriptive commit messages. 7. Push your changes to your fork on GitHub. 8. Submit a pull request. Include a clear and detailed description of your changes.
Code of Conduct
Participants in the wandR project are expected to follow our Code of Conduct, which can be found in the CODE OF CONDUCT. This code outlines our expectations for behavior within the project’s community.