8000 DropletInk · GitHub
[go: up one dir, main page]

Skip to content
@DropletInk

DropletInk

Process Handbook

Collaboration

We use GitHub as the principal collaboration platform for software development projects. Try to put all your ideas, queries, concerns here.

In addition to GitHub, we prefer @teams over voice call. Send a request to talent@droplet.ink for being invited to the channel.

Issues and Request for Requirement

⚠️ Please note
All the changes in dev branch must come through Pull Requests created by developers to keep track of changes. Please do not upload any file in the dev branch directly. Additional files can be added to Issues or comments by attaching the file in the description, not directly into the repository.

Additionally, we generally try to avoid uploading executable files in the source code repository directly. Executable files are created through build from source code, so only source code should be kept in the repository.

Guidelines for capturing video while reporting an issue.

Download -> Installation -> Configuration

  1. Download recommended screen recording software from here
  2. Install the software
  3. Change the default settings for optimal video sharing in github as shown in the following images
  • Before your changes settings are as below: bandicam-installation-default
  • After your changes settings should be as below: bandicam-installation-after-changes

Recording the video while reporting issues:

  1. Always start with Apps' home screen. It ensures that developers can reference the version of target App for the issue.
  2. Record all the steps necessary for reproducing the issue
  3. Hover your mouse on the part of the UI where attention is required by the developers to understand the issue.

Mentions steps as per the Issue Reporting Template

  1. Add the steps as per the issue reporting template in writing so that the video and the steps can be correlated by the developer trying to fix the issue.
  2. Take backup of the database, zip it and add it in the issue so that developers can reproduce accurately
  3. And of course try to mention any other related information that you may think useful

The developers at Nevaeh just wanted to thank you for taking the time to keep us informed so well. We know you’ve got a full workload going and we wanted to share with you a browser app that has helped us tremendously (BIG time saver)! Check out Grammarly. It helps to autocorrect spelling, punctuation and even synonyms instantly, so you can keep being awesome as always and save a bit of time. Thanks again to all of you for contributing!!!

To express your idea harness the power of Markdown. Markdown has simple syntax to format your writing. Spend some time in learning it. Be assured that your time won't be wasted. It will allow you to communicate more expressively. Check it out. Markdown is 🚀

Developer's Handbook

  1. Any feature/bug to be addressed should be clearly written down in an issue first. It gives all the stakeholders to have a common understanding of what's expected when the work is done.

  2. For new feature development write in with small, manageable development parts. Issues should be treated as functions in computer science; meant to do one thing and one thing well. An issue trying to address too many things often results in code smell

  3. Always create Pull Request(PR) to resolve issue, never directly push in main branch.

    1. First, create a branch from an issue following this.
    2. Checkout the branch locally with git fetch; git switch <new-branch-name>.
    3. Commit and push your changes to the new branch.
    4. Compare branches and create PR following this.
    5. Push all subsequent commits for that issue to the PR branch
    6. When you have successfully fixed the issue, add a video to demonstrate the fix.
    7. When done, assign a reviewer to the PR, after PR is approved by the reviewer, the PR can be merged to the main branch, squashing all the changes together in a single commit.

    Exception to this rule is only applicable for initial commits of a repository to create a reasonable base. For example, when creating a new repository there may be a few commits to bring the code in stable state. After that, always use PR to resolve issues.

  4. There is one default branch in a repository from which the software is released. Always create a new branch from the default branch.

  5. Sync with the default branch of the repository. And sync often.

  6. Keep logical completions in separate commits.

  7. Commit with clear and meaningful commit messages. Here's a good starting point in your journey with git.

⚠️ Default Branch
Default branch can have different names based on the repository you are using. E. g., main, dev etc. Check your repositories' default branch before creating branches and syncing
  1. Following are some typical use cases of git

    • Cloning a repository
       git clone <repository> 
       git submodule --init --recursive

    NOTE: git submdoule --init -recursive is necessary if there's a submodule in a repository. However, do it to avoid confusing error messages during compilation if one exists, and you forgot to initialize the submodule.

    • Syncing with the default branch
       git pull origin <dev> 

    NOTE: Where dev is the respositories' default branch

  2. A day in the life of programmer from source code management point of view. The scenario is as follows

    You are working on an issue. You have downloaded the repository, made changes to the source code and tested it locally. It seems to meet the expected behavior and has passed all necessary test cases. It's time that you update the source code in your remote git repository.

    git add -u
    git commit -m "<Changes defined in clear and concise message>"
    git pull origin <default branch>
    git submodule update --init --recursive
    git push

    git add -u - Stages all the changed files for commit

    git commit -m "<Changes defined in clear and concise message>" - Commits the changes in your local repository. Change the commit message reflecting the changes you've done in this commit.

    git pull origin <default branch> - Sync with default branch of your repository

    git submodule update --init --recursive - Sync submodules (if one exists) for the repository.

    NOTE: You should always build your source after this. There's always a possibility that changes by somebody else might interfere with your portion of change, leaving your version of the code broken. If that happens you need to fix it locally. Also you should test your code and verify whether it yields different results than you expected. If so happens, fix it and then start all over again.

    git push - Updates your branch to remote repository

    Please go through the below video or presentation for some typical cases in Git. gitexplainer.webm gitexplainer.odp gitexplainer.pptx

UI/UX (WIP)

  1. Web

    • Use light background. Prefer to use [oklch(92.8% 0.006 264.531)] for the background. image
    • Use [oklch(0.202 0 162.37 / 0.85)] for free flowing texts over default background (other than texts over buttons or any other html elements). image
    • Use [oklch(55.61% 0.24767775297588435 276.454417954991)] for primary button background color image, white for text color.
    • Use [oklch(0.5401 0.2734 29.64 / 0.649)] for errors and warning. image
    • Use JetBrains Mono for all texts.
    • Be judicious while choosing units. Read this wonderful article for internalizing the concepts behind.
    • Be precise yet informative with UI/UX writing. Follow the principles mentioned hre.
  2. Desktop

    • Always stick to Windows default.

Product Management

We follow Scrum to manage development of products @droplet

What is Scrum?

Scrum is an Agile framework that structures work into time-boxed sprints, with defined roles, artifacts, and ceremonies for iterative delivery. 

Key roles include product owner, Scrum master, and development team, all collaborating to achieve sprint goals. 

Scrum emphasizes transparency, inspection, and adaptation, enabling teams to respond to change and deliver value incrementally. 

The Core Scrum Ceremonies

Sprint Planning: The team plans the upcoming sprint, deciding what work to tackle (from the Product Backlog) and how to do it, forming the Sprint Backlog. 

Daily Scrum (Stand-up): A brief, daily 10-15-minute sync where the team shares progress, plans for the day, and highlights any impediments (blockers). 

Sprint Review: At the end of the sprint, the team demonstrates completed work to stakeholders to gather feedback. 

Sprint Retrospective: The team reflects on the sprint, discussing what went well, what didn't, and identifies actions for improvement in the next sprint.  

Implementation

Details Time/Day/Interval
Sprint Duration 10 days
Sprint Planning Tuesdays at 10 days interval
Daily Scrum 10-15 mins, daily
Sprint Review Mondays (end of the sprint)
Sprint Retrospective Mondays (end of the sprint)
SPRINT DAYS Day 1 (Tue) Day 2 (Wed) Day 3 (Thu) Day 4 (Fri) Day 5 (Mon) Day 6 (Tue) Day 7 (Wed) Day 8 (Thu) Day 9 (Fri) Day 10 (Mon)
Activity Start of the Sprint - Sprint Planning Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Daily Scrum/Backlog Refinement Sprint Review + Sprint Retrosprective
Responsibility Entire Scrum Team Developers and the entire team Developers and the entire team Developers and the entire team Developers and the entire team Developers and the entire team Developers and the entire team Developers and the entire team Developers and the entire team Scrum Team and key stakeholders

We encourage you to read more about Scrum @ Atlassian and various other resources you stumble upon at www

Popular repositories Loading

  1. resilience-features resilience-features Public

    Backend resilience features including retry logic, exponential backoff, timeout handling, and rate limiting.

    TypeScript 1

  2. backend-utils backend-utils Public

    Commonly used backend utilities

    Python

  3. .github .github Public

  4. simple-otel-logger simple-otel-logger Public

    make a logging library for structured logging

    TypeScript

  5. dummy-microservices-for-logging dummy-microservices-for-logging Public

    It includes 3 micro-services that has 3 levels of logs info, warn and error.

    Shell

  6. log-aggregation-system log-aggregation-system Public

    log aggregation system using Docker logging driver

Repositories

Showing 9 of 9 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…

0