Skip to content

Latest commit

 

History

History
20 lines (20 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

20 lines (20 loc) · 1.98 KB

Contributing to Haly

We welcome contributions from everyone! Whether you're a developer, designer, or just an enthusiastic user, there are many ways you can contribute to Haly's development.

Reporting Issues

If you encounter any bugs, glitches, or other issues while using Haly, please let us know by opening an issue. Be sure to include as much detail as possible, such as steps to reproduce the issue and your operating system.

Creating Pull Requests

If you'd like to contribute code or new features to Haly, we encourage you to submit a pull request. Here's how you can get started:

  1. Fork the repository and clone it to your local machine.
  2. Create a new branch for your changes: git checkout -b my-feature-branch.
  3. Make your changes and commit them with descriptive messages.
  4. Push your branch to your forked repository: git push origin my-feature-branch.
  5. Open a pull request on the main Haly repository, explaining the changes you've made and why they should be merged.

Code Style

To maintain consistency and readability, please follow the existing code style and conventions used in Haly. This includes using proper indentation, meaningful variable names, and commenting where necessary.

Documentation

Improving the documentation is always appreciated. If you notice any gaps or have suggestions for improving the documentation, please submit a pull request with your changes.

Testing

We value robust and reliable code. If you're contributing new features or making changes, please ensure that appropriate tests are included. This helps us maintain the quality of Haly and prevent regressions.

Code of Conduct

Please note that we have a Code of Conduct in place for all contributors. By participating in this project, you are expected to adhere to the code of conduct. Thank you for your interest in contributing to Haly! We appreciate your help in making Haly even better.