Skip to content
Chai aur Docs

Commits & Pull Requests

Before opening a pull request let’s discuss the commit messages and pull requests workflow.

Commit Messages

We follow the Conventional Commits standard for commit messages.

  • Format: <type>(<scope>): <subject>
  • Type: Describes the type of change (e.g., feat, fix, docs, style, refactor, test, chore).
  • Subject: A concise description of the change.

Examples:

  • fix: improve ui on mobile view
  • docs(devops): add Docker installation guide

Guidelines:

  • Present Tense: Use the present tense for describing changes (e.g., “add JavaScript docs” instead of “added JavaScript docs”).
  • Imperative Mood: Use the imperative mood (e.g., “move cursor to…” instead of “moves cursor to…”).
  • Lowercase: Write all commit messages in lowercase letters.

Pull Requests

ChaiDocs use the GitHub flow as main versioning workflow.

  1. Fork the repository
  2. Create a new branch for each feature, fix or improvement
  3. Send a pull request from each feature branch to the main branch

It is very important to separate new features or improvements into separate feature branches, and to send a pull request for each branch.

This allow to review and pull in new features or improvements individually.

Start your journey with ChaiCode

All of our courses are available on chaicode.com. Feel free to check them out.