👍🎉 First off, thanks for taking the time to contribute! 🎉👍
Contributing to Crossbar.io is totally welcome! We love open source and community collaboration. All of Crossbar.io development is fully open here on GitHub and there are no private, closed areas that exclude you and the Crossbar.io community.
The guidelines here give some tips on how to best contribute. Please try to follow these. It's short, quick and easy. This will ensure a smooth process. Thanks again for contributing!
Quick Links
We track issues in the GitHub issue tracker here.
An issue is either a bug (an unexpected / unwanted behavior of the software or incorrect documentation) or a feature (a desire for new functionality / behavior in the software or new documentation).
A question though is not an issue - as in, it isn't handled in our issue tracker by purpose / policy.
So if you have found a bug or want to propose a new feature, please file an issue. But if you have a question, please see [Asking Questions](#Asking Questions)
If you file a bug issue, please provide at least the following information:
- output of
crossbar version - error/log output (eg a traceback)
- steps to reproduce the issue
A bug issue should also be only about one thing - if you have found multiple related things, please file multiple issues and link the issues (cross referencing by mentioning the related issues in the descriptions - that will make GitHub automatically add respective links).
When proposing a new feature, please provide the following:
- your actual use case and your goals
- why this important for you
- optionally, a proposed solution
Describing your use case and goals, rather than only / directly jumping into a specific, concrete proposal for a solution is very important. As this allows us to take into account the bigger picture. If you "only" propose concrete solution, and that doesn't fit in, we might need to reverse engineer your actualy use case / goals first to then come up with a solution that fits.
A question about Crossbar.io is neither a bug nor a feature. Hence, if you have a question, please DO NOT file an issue, but consider asking on one of the following channels.
Questions are best asked here:
- on the mailing list
- on StackOverflow or
- on IRC channels (
#autobahnand#crossbaratchat.freenode.net).
When you file an issue that is considered a mere question, your issue likely will get closed without any further discussion or reply. You might find that unpleasant or non-cooperative. We are sorry! It is meant to be rude, but the reasons are: a) we are running this project on limited resources and b) the issue tracker should stay focused and not drown in noise.
To contribute code to Crossbar.io, please see guidelines Contributing to the project.
Contributions to the documentation are highly welcome! Crossbar.io is a complex software, users have varying degrees of background and experience and we have limited resources. Also, developers of Crossbar.io usually don't have a user perspective (anymore) - but docs should be for users.
All Crossbar.io documention is written in (enriched) Markdown and contained in this repository here.
The documentation is the built (by us) and deployed here.
For further details, please see here.