Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 2.54 KB

CONTRIBUTION.md

File metadata and controls

44 lines (33 loc) · 2.54 KB

Contribution Guidelines

We are grateful for any contributions made to this project. Before contributing, please take a moment to review this document.

Getting Started

  1. Fork the repository to your GitHub account by clicking the "Fork" button in the top right corner of the repository page.
  2. Clone the forked repository to your local machine using the command git clone <repository-url>.
  3. Install the required dependencies by running the command npm install or yarn install.
  4. Make the necessary changes to the code. You can run the command npm run dev or yarn dev to start the development server and test your changes.

Submitting Changes

  1. Create a new branch for your changes. The branch name should follow the format <feature/bugfix>/short-description.
  2. Make the necessary changes to the code and commit them with a descriptive commit message.
  3. Push the branch to your forked repository using the command git push origin <branch-name>.
  4. Create a pull request by clicking the "New pull request" button on your forked repository page. Make sure to select the correct base branch and compare branch.

Code Style

  1. This project uses the Prettier code formatter. You can run the command npm run format or yarn format to format your code.
  2. This project uses the ESLint linter. You can run the command npm run lint or yarn lint to lint your code.

Commit Message Guidelines

  1. The first line of the commit message should be a short summary of the changes. This line should be no more than 50 characters long.
  2. The second line of the commit message should be blank.
  3. The third line of the commit message should include a detailed description of the changes. This line can be as long as necessary.
  4. Use the present tense when writing commit messages. For example, "Fix bug" instead of "Fixed bug".
  5. Use an imperative tone when writing commit messages. For example, "Add new feature" instead of "Added new feature".
  6. Use the following prefixes for your commit messages:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • style: for code style changes
    • refactor: for code refactorings
    • perf: for performance improvements
    • test: for new or updated tests
    • build: for build-related changes
    • ci: for continuous integration changes

License

By contributing to this project, you agree to license your contributions under the MIT License.