search

macxred / cashctrl_api

Python client for the CashCtrl REST API
MIT License
0 stars 0 forks source link

Feat: update contributing file #23

Closed AlexTheWizardL closed 3 months ago

AlexTheWizardL commented 3 months ago

Naming Patterns

The Naming Patterns section establishes a consistent and structured approach for naming branches, commits, and pull requests in a repository. This consistency helps developers understand the purpose of each branch, commit, or pull request at a glance. Below is a description to include in your pull request.

Naming Patterns Overview

To maintain consistency and clarity within the repository, we follow specific naming patterns for branches, commits, and pull requests. These patterns make it easier to track changes and identify the purpose of each item.

Branch name

(feat|fix|docs|style|refactor|test|revert)/taskId_task-short-description
Ex.: feat/1_add-commit-and-branch-name-styles-to-readme

Commit name

(feat|fix|docs|style|refactor|test|revert): update descriptions
Ex.: bug: update readme

Commit description

tickets: #taskId, #taskId
Ex.: tickets: #1, #2, #3

Pull-request name

(Feat|Fix|Docs|Style|Refactor|Test|Revert): #taskId description
Ex.: Fix: #15 unnecessary request removed

Installing Pytest for Testing

To run tests with pytest, ensure you have it installed on your system. Pytest is a widely used testing framework in the Python ecosystem, known for its ease of use and support for various types of tests, including unit and integration tests.

To install pytest, follow these steps:

  1. Open a terminal or command-line interface.
  2. Run the following command to install pytest:
pip install pytest
lasuk commented 3 months ago

Merged. Thanks a lot!