We'd love for you to contribute to our source code and to make BioJS even better than it is today! The BioJS community is very young and rapidly growing - so we are still working on making it more smooth for newcomers to get started. Nevertheless we have some general advices for you to make an awesome contribution.
- How to get started
- How to contribute
- Issues and Bugs
- Feature/Component requests
- Submission guidelines
- Learn how to create your own BioJS component
- Look at existing components and learn how they are written
- Here is a list of services provides by BioJS
Interesting talks:
You can find more talks here.
Here are some general ideas:
- Browse our issue list (or all BioJS repositories) for ideas
- Propose your own ideas
- Don't hesitate to ask more specific questions on github, gitter or our mailing list
Your contribution could be:
- Improve an existing component and send a pull request (see the BioJS registry)
- Create your own component (see the wishlist if you don't have an own idea)
- Help us at building the BioJS infrastructure (registry, docs, ...) (not a complete list)
If you are about to create a new component, is generally a good idea to ask us (github issues, gitter, irc) if someone is already working on a similar project.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature or component, you can also get help on our issue tracker ;-)
Before you submit your issue search the archive, maybe your question was already answered.
- Search GitHub for an open or closed issue or pull request that relates to your submission. You don't want to duplicate effort.
- If your issue appears to be a bug, and hasn't been reported, open a new issue.
Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
- Overview of the Issue - if an error is being thrown a non-minified stack trace helps
- Motivation for or Use Case - explain why this is a bug for you
- Related Issues - has a similar issue been reported before?
- Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
That's it! Thank you for your contribution!
We are happy to help you via Gitter, Google groups or IRC.