Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.95 KB

Contributing to Hawqal

Thanks for considering contributing to Hawqal! We welcome contributions of all kinds, including bug reports, feature requests, and code contributions.

Reporting Bugs

If you think you've found a bug in Hawqal, please report it by opening an issue. When reporting a bug, please include as much detail as possible, including the version of Hawqal that you're using, the operating system and version, and any relevant error messages or logs.

Requesting Features

If you have an idea for a new feature that you'd like to see in Hawqal, please open an issue and describe the feature. If possible, please include details about how the feature would be used and any potential benefits.

Contributing Code

We welcome code contributions of all kinds! If you'd like to contribute code to Hawqal, please follow these steps:

Please make sure to include test cases for any new code that you contribute, and make sure that the tests pass before submitting your pull request.

Code of Conduct

We expect all contributors to Hawqal to follow the Code of Conduct.

Commit Message Conventions

We follow the Conventional Commits format for commit messages. Please make sure to follow this format when committing code.

Code Review and Testing

All pull requests should be reviewed by at least one member of the Hawqal team or by collaborators before they merge into the master.

Running Examples

cd example  
go run main.go

To run the test

go run example/main_test.go