Contributing & Issue Guideline

[hanseaston]

Hello there! We are happy to have you here ☺️

Here's a few things to note before you start diving into the project and all the fun!

• The issue page here consists of the problems and potential ideas people can contribute to the current project.

• You are also use this page to ask clarifying questions and pose interesting ideas and perspectives to the project.

• The tags will help you understand the type of a particular issue and will guide you make an informed decision on whether the issue is suitable for you or not.

• Milestones are groups of more challenging topics of the project. There are usually about some bigger concepts and goals of the future of our project. We will usually have multiple issues that relate to or reference to one of the milestones.

• If you are new to the project, please look out for issues tagged with "beginner-friendly". These are usually the ones that only require a few lines of fixes and will help you transition into contributing without feeling overwhelmed! Check out Stepping up project commenting! #36 as well, this is a really good opportunity for starters. You can comment on project files while contributing to this issue at the same time. It is a really good way to understand what the project is doing.

• Feel free to open an issue (asking a question, posing a new idea, fixing a certain bug) and mark the appropriate the tags. If your issue is related to a particular milestone, please add the relevant milestone as well. Always add the "Issue progress" for the projects tab. All the settings can be found on the right-hand-side of the issue page.

• When you open an issue, describe your issue, concern, or questions with appropriate description. Attach images, code snippets, and use the markdown as appropriate. Please check out the Github markdown guide on how to style your issue description.

• Whenever you want to contribute to an issue, make sure someone else is not in the process of contributing to the same issue (it would suck if you guys have conflicting works!). To prevent people accidentally working on the same issue, please make a comment on the issue letting us know you want to contribute before your work on it! This is to let others know that you have been working on this issue. I will also assign your Github username to that particular issue just to be safe!

• You are more than welcome to comment on a certain issue, ask followup question, and exchange ideas with others. Please be respectful though!

• Once you finish resolving an issue and submit a pull request, one of the project organizers will review your code and merge it when everything looks good!!

• If you would like to learn more the workflow of Github issue, check out the official guide!