Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (53 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

69 lines (53 loc) · 2.68 KB
Raw

Development

Kanban board

Here is our Kanban board

Columns:

  • Sprint
    • Difficulty assessed (story points)
    • Acceptance criteria are specified
    • Addition to the column approved by the customer
    • Someone on the team plans to do this during the sprint
  • In progress
    • Someone signed up for this task and started working on it
  • Done
    • Task is done(acceptance criteria done)
    • Execution approved by team members
  • Paused/Research required
    • A team member started working on this task but was unable to complete it.

Git workflow

For our project we used GitHub flow.

Rules:

  • For creating issues from the defined templates:
  1. Create an issue and immediately set acceptance criteria for it

  • For labeling issues:

    Currently we have 7 labels. Tasks can be labeled based on these rules:

  1. frontend - Should be used for an issue that involves changing the user interface.
  2. backend - Should be used for an issue that is related to a part of the project that is not visible to the user.
  3. bug - Should be used for an issue that arose after an error was noticed in the project's operation.
  4. enhancement - Should be used for an issue that somehow improves the work of the project, but without which the project works.
  5. task - Should be used for an backlog task.
  6. triage - Should be used for some task that is not sorted yet.
  7. user story - Should be used for issue that formulated in user-story-format.
  • For assigning issues to team members:
  1. Each team member selects tasks from the sprint that they want to complete.
  2. If any tasks from the sprint remain without an assigned teammate, this task goes to the one who has fewer user points for his tasks.
  • For сreating, naming, merging branches:
  1. Creating: For all issues should be created separate branch.
  2. Naming: Name of branch should briefly explain the purpose of creating this branch.
  3. Merging: To merge branch with "dev" branch teammate must create pull request.

  • For commit messages format:

    A commit should explain what changes were made to the project.

  • For creating a pull request for an issue using a pull request template:

  • For code reviews:

  • For merging pull requests:

  • For resolving issues:

Secrets management

We have no password or API keys for now, so we have no secrets