FAQs & Getting Started Guide for Hacktoberfest 2023

[animator]

Hi Contributors! Welcome to API Dash ⚡️

API Dash is the 1st open source cross-platform API client built using Flutter that works on macOS, Windows & Linux. We are participating in Hacktoberfest this year.

Some FAQs:

1. What is the communication channel for the project?

All contributors should join our Discord server and discuss any doubt/issue in the #hacktoberfest-foss channel. We recommend it as our entire team is on this server and it will be easier to guide you.

2. What are the prerequisites?

Our tech stack is Dart & Flutter. So in case you are new, you can learn the basics from the official docs here - Flutter & Dart.

In case you want to work on non-code contribution like project user guide, documentation or create a demo video demonstrating any feature, feel free to raise an issue and we will guide you & help you create it.

3. I am interested in solving an issue, will you assign it to me?

We do not assign issues on "first come, first serve" basis. We are looking for serious contributors, so we guide you in coming up with a solution (via discord) and assign it once we receive a PR which is working towards the direction of resolving that issue.

4. How can I contribute to the project?

Here is a step by step approach:

• Go through the README.md to understand what the project does.
• Download a version of API Dash as per your OS and play around with it. This will help you get familiar with the tool and also help you identify anything that is missing that you can add as a new feature (by raising an issue).
• Go through the CONTRIBUTING.md to setup API Dash local development environment and for all contribution guidelines.
• Take a look into the existing (or create new) project issues that you will now be able to understand better after getting familiar with API Dash.
• Choose an issue that you find interesting to work on and the comment on it. Chat in the #hacktoberfest-foss channel in case you have any doubts while working on the issue.
• After making code changes, send a PR for review linking the issue.

5. I don't know if I will be able to resolve the issue? What if my code is not merged?

Open source is about the journey and not the end goal. So the first thing you need to do is to stop worrying whether you will be able to do anything or not. It is a learning journey and you have to take the first step to initiate a conversation. The project team will definitely guide you towards achieving the goal. It may take some time, but if you are passionate, you will definitely achieve the goal.

Happy coding!

In case you have any further questions, kindly feel free to drop a comment below 👇