Contribution Documentation (Reference Research)

[nomadbitcoin]

• [x] Copy contribution standards from the studied repositories and create a standard guide.
• [x] Create a basic document on how to contribute using GitHub Kanban.

[nomadbitcoin]

Guide to Using GitHub Kanban Boards

Welcome to our community! This guide will help you understand how to use GitHub Kanban Boards to manage and contribute to our projects. Our boards are organized by teams and can be accessed here.

Table of Contents

1. Introduction to Kanban Boards
2. Accessing the Boards
3. Understanding the Columns
4. Task Fields
5. Moving Issues Between Columns
6. Best Practices
7. FAQs

---

Introduction to Kanban Boards

Kanban Boards in GitHub help visualize your workflow and manage your tasks efficiently. Each board consists of columns that represent different stages of the workflow, such as "Backlog", "To Do", "In Progress", "QA", and "Done".

Accessing the Boards

1. Go to our GitHub organization projects page.
2. Select the board you want to view based on your team or interest area.

Understanding the Columns

Each board typically contains the following columns:

• Backlog: Tasks that are identified but not yet prioritized or scheduled for work.
• To Do: Tasks that are ready to be started.
• In Progress: Tasks that are currently being worked on.
• QA: Tasks that have been completed and are awaiting quality assurance checks.
• Done: Tasks that have been completed and approved.

Task Fields

Each task (issue) on the board includes the following fields:

• Assignee: The person responsible for completing the task. (Empty until someone claims it)
• Skill: The required skill for the task, which can be one of the following: analysis, content, copy, design, dev, operational, marketing, research, strategy.
• Effort: The estimated effort required for the task, categorized as:
  • 2: Basic
  • 4: Medium
  • 8: High
• Importance: The priority level of the task, which can be low, medium, or high.
• Start Date: The date when the task is scheduled to begin.
• End Date: The date by which the task should be completed.

Moving Issues Between Columns

1. Open the Kanban board from the projects page.
2. Drag and drop the issue cards between columns as the task progresses through different stages.
   • Move to "To Do" when the task is ready to be started.
   • Move to "In Progress" when you start working on it.
   • Move to "QA" when you complete the task.
   • Move to "Done" after the task has passed quality assurance checks and been approved.

Best Practices

• Clear Descriptions: Always provide clear and detailed descriptions for issues.
• Regular Updates: Regularly update the status of your tasks on the board.
• Communicate: Use comments on issues to communicate progress, blockers, or ask for help.
• Review: Participate in the review process to help maintain quality and consistency.

FAQs

Q1: How do I join a project board?

A: To join a project board, comment on an issue stating that you would like to take on the task. If your request is approved, you will be added as the assignee for that issue.

[nomadbitcoin]

Code Contribution Guide

Part 1: Forking and Creating a Branch

1. Fork the Repository:

   • Navigate to the repository of the platform you want to contribute to.
   • Click the "Fork" button at the top right of the repository page. This creates a copy of the repository under your GitHub account.

2. Clone the Forked Repository:

   • Clone the forked repository to your local machine using the following command:

     git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git

   • Replace YOUR_USERNAME with your GitHub username and REPOSITORY_NAME with the name of the repository.

3. Create a New Branch:

   • Change to the repository directory:

     cd REPOSITORY_NAME

   • Create a new branch for your changes:

     git checkout -b your-branch-name

   • Replace your-branch-name with a descriptive name for your branch.

Part 2: Making Changes and Submitting a Pull Request

1. Make Your Changes:

   • Implement the changes or improvements you want to contribute.
   • Stage the changes:

     git add .

   • Commit the changes with a descriptive message:

     git commit -m "Describe your changes"

2. Push the Changes to Your Fork:

   • Push your branch to your forked repository on GitHub:

     git push origin your-branch-name

3. Submit a Pull Request:

   • Go to the original repository on GitHub.
   • Click on the "Pull Requests" tab.
   • Click the "New Pull Request" button.
   • Select the branch you created in your forked repository and compare it with the main branch of the original repository.
   • Provide a clear and detailed description of your changes.
   • Submit the pull request.

4. Follow the Review Process:

   • Respond to any feedback or requests for changes from the project maintainers.
   • Make necessary updates and push them to your branch. The pull request will update automatically.

If you need more detailed guidance, you can follow this excellent tutorial for first-time contributors: First Contributions.