About the Ideas Section

[crichez]

💡 Welcome to the ideas section!

I have a suggestion or request, how should I share it?

Thanks for contributing! Whatever your idea is, we would be happy to hear it. Discussion posts are great to talk about your use case if you don't feel confident enough to submit an issue. You don't need to worry about duplicate issues, or implementation details. The discussion can help you come up with the details required to submit an issue, and brainstorm solutions that will eventually turn your issue into a pull request.

How do I know if my idea is in the scope of the project?

By asking! This project is only a library of hashers, but aspires to be a foundational framework for anything related to Fowler-Noll-Vo hash functions. If we collectively decide your idea is out of scope, that simply means it belongs in a different repository. You can still find valuable support and insight by sharing your ideas here.

What should my idea post look like?

Although issues and pull request should be structured consistently, discussion posts can be as freeform as you think is appropriate. A new idea might just be a question to the maintainer(s). An idea might come from a Q&A post, in which case it should summarize the discussion and link to key posts. You may already have some code written up, in which case you can use a post as a pre-cursor to a pull request and include objectives, tasks, implementation details and sample code.