Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.5 KB

Contributing to Walrus

Thanks for taking the time to contribute to Walrus!

Please review and follow the Code of Conduct.

Filing Issues

If you find any bugs or are having any trouble, please search the reported issue as someone may have experienced the same issue, or we are actively working on a solution.

If you can't find anything related to your issue, contact us by filing an issue. To help us diagnose and resolve, please include as much information as possible, including:

  • Walrus: What version of Walrus are you using, what deployment method, etc.
  • Hosts: What specifications does the host have, like CPU/memory/disk.
  • Environment: Are you in a proxy environment, are you using recognized CA/self signed certificates, etc.
  • Steps to reproduce: Provide as much detail on how you got into the reported situation.
  • Logs: Please include any relevant logs, such as Walrus server logs, service deployment logs, etc.

Contributing Code

For setting up development environment, please refer to Development Guide.

If you're fixing a small issue, you can simply submit a PR. However, if you're planning to submit a bigger PR to implement a new feature or fix a relatively complex bug, please open an issue that explains the change and the motivation for it. If you're addressing a bug, please explain how to reproduce it.

Updating Documentation

If you have any updates to our documentation, please make a pull request to the docs repo.