Blog: How to create the best possible Issues
Discover more from BioDrop
Blog: How to create the best possible Issues
Our journey to making a BioDrop Issue template
Even before Hacktoberfest noticed that a lot of issues are being raised by the community on BioDrop. Our mission is to make sure that these are clear and well thought out when they are raised, as we truly feel that this helps everyone! How?
Maintainers can more easily understand what the issue is about and if it fits in with the project’s roadmap.
Contributors can decide whether they want to ask that this issue be assigned to them, as they will be able to understand what will be required.
Sometimes drafting a really good issue comes about by asking questions from the author about what they intend and filing in the gaps. At BioDrop we believe that the best place to start however is having a really good issue template. In this blog we go through the questions we ask and the information we request in our issue template and the best way to address these.
What kind of issue is it?
Firstly decide whether you want to raise an issue related to a Bug or a Feature. You can then select the appropriate template.
Avoid duplicates
You would be surprised how many issues are raised that are duplicates. That is why in the BioDrop issue template we ask our contributors to confirm they have checked that the issue they want to create is not a duplicate.
It is important to check both current issues but also ones that have been closed or merged.
It takes a very short time to check and it makes such a difference to the maintainers! It will also reduce the confusion for contributors looking at the project.
Do you want to work on it? It’s not just about saying “Yes”
If you are familiar with BioDrop you know that we have a set of guidelines on how we assign issues (you can find these in our Contributing Guide). For example, we try to assign the issue to the first person who requests this in the comments section.
We want to make it easier for you to work on the issue which you have created. We don’t want you to miss out because you were not the first one to comment!
So, if you do not have any other issues assigned to you then make sure you answer the question “Do you want to work on this issue?” by clicking “Yes” on the dropdown!
Next, is a really important question:
Whilst we want BioDrop to be a place where you come to learn and try new things, if you want to work on a issue it is important that you understand how you would technically implement the changes you would need. That does not mean that, when you are working on it you shouldn’t ask questions in the EddieHub Discord! However it is important that you have at least the basic knowledge on how to get started.
In this section give as much detail as possible, including referencing any existing code.
[If you don’t know how to implement the issue, then this should not stop you from raising it! It might be that there is another contributor best suited to work on it and you can take that opportunity to learn from them and collaborate.]
Give Context: Features
We have added the following fields for you to complete which will help describe the issue you are raising:
Is this new feature related to a problem or an unavailable functionality?
What solution do you propose?
Screenshots - always good to add context!
Give Context: Bugs
When reporting a Bug, you also have the opportunity to give as much information as possible.
We ask:
Whether you found the bug in the local dev environment or production?
What version if BioDrop? (avoid using terms like the word “latest” - you can find the version number in the footer of our website)
Final template
…So if you are ready to raise an issue then head over to our New Issue page on the BioDrop GitHub Repo!
*Note: you can watch Eddie’s video on BioDrop’s full issue template!
Bonus Tips!
Choose the right template! Is it a Bug? Is it a Feature?
Complete all the sections as best as you can - this will improve your chances of getting the issue accepted.
Is this the first time you raise an issue for the BioDrop project? Or even contribute? Check out our Contributing Guide first.
[Not ready to raise an issue but want to work on an existing one? Check out Eddie’s video on finding the right issue for you!]
Look forward to your contributions!
Sara