Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 2.33 KB
Raw

Contributing to Sailboat Gym

Thank you for considering contributing to Sailboat Gym! We appreciate your interest in making our project even better. Here are some guidelines to help you get started with your contribution.

Bug Reports and Feature Requests

If you come across a bug or have a feature request, please ensure that it has not already been reported or requested by searching through the issue tracker. If it hasn't been addressed yet, feel free to open a new issue and provide as much detail as possible, including steps to reproduce the bug or a clear description of the desired feature.

Pull Requests

We welcome pull requests for bug fixes, new features, or improvements to existing functionality. To submit a pull request, please follow these steps:

  1. Fork the repository to your GitHub account.

  2. Clone your forked repository to your local machine.

    git clone https://github.com/lucasmrdt/sailboat-gym.git

  3. Create a new branch for your feature or bug fix.

    git checkout -b feature-name

  4. Make the necessary changes and commit them with descriptive commit messages.

    git add .
git commit -m "Add feature or fix bug"

  5. Push your changes to your forked repository.

    git push origin feature-name

  6. Open a pull request from your forked repository to the main Sailboat Gym repository.

  7. Ensure that your pull request provides a clear description of the changes made and any additional information that may be relevant.

Code Guidelines

To maintain consistency and readability, please adhere to the following guidelines when contributing to Sailboat Gym:

  • Follow the existing code style and naming conventions.
  • Write clear and concise documentation for new features or modifications.
  • Include appropriate tests for your changes to ensure code quality.
  • Avoid introducing unnecessary dependencies.

Code of Conduct

When contributing to Sailboat Gym, please be respectful and considerate of others.

License

By contributing to Sailboat Gym, you agree that your contributions will be licensed under the terms of the MIT License.

We appreciate your valuable contributions and look forward to your involvement in making Sailboat Gym a powerful tool for sailboat simulation and experimentation.