Skip to content

Latest commit

 

History

History
51 lines (29 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

51 lines (29 loc) · 2.57 KB

Contributing

What & How Can You Contribute?

1. Feedback

Contributions in the form of feedback and issue is very much welcome. Might it be a suggestion, a bug report or maybe some questions that you have. It helps improving Ogmios in the long run and these are probably the best kind of contributions to start with. See About Issues/Discussions below for guidelines.

Do not hesitate to upvote discussions or comments to show your interest!

2. Code

Refer to the building and testing sections of the user-manual if you're willing to hack a bit on Ogmios. The project follows a quite strict architecture as detailed in the server's README.

Past (and future) design decisions have been (will be) recorded as Architectural Decision Records. Have a look at them before you start hacking to better understand some of trade-offs made during the development.

Coding standards are enforced using tools and configuration defined in the repository. Make sure to configure your editor to pick them up.

Pull requests are welcome, but we do recommend to open an issue to bring any idea to discussion first!

3. Donation

Want to give some financial support? Have a look at the sponsors page for more details.

About Issues

🐛 How To Report A Bug

Open a Bug Issue.

💡 How To Propose An Idea

Feel free to bring it as a discussion [category: idea]. Make sure to highlight your use case so we can understand the design space and agree on a solution.

[!INFO] Ideally, follow this simple template:

  • What is your idea? Describe it in simple words. Provide a use case.
  • Why is it a good idea?
  • What is the current alternative and why is it not good enough?

❓ How To Ask a Question

Open a Q&A Discussion.

Important

Make sure to mark your question as Answered once resolved!

Need Help Getting Started?

Should you be unsure about where to start, feel free to come and chat on DiscordDiscord (#ogmios).