Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

41 lines (29 loc) · 1.79 KB
Raw

Contributing

Thank you for considering contributing to the Zeri project! We appreciate your support and efforts in making this project better. Please take a moment to review the following guidelines before making contributions.

Getting Started

  1. Fork the repository and clone it to your local machine.
  2. Make sure you have pnpm on your system.
  3. Install the required dependencies by running pnpm install.
  4. Start the development server by running pnpm run dev.
  5. Make your changes and ensure they work as expected.
  6. Submit a pull request with your changes.

Code Guidelines

  • Follow the coding structure and conventions used throughout the project.
  • Write clean, readable, and maintainable code.
  • Use meaningful variable and function names.
  • Document any complex logic or non-obvious code with comments.

Testing

  • Write unit tests for any new functionality or bug fixes.
  • Make sure all existing tests pass before submitting your changes.
  • Run the test suite using pnpm run test:unit to validate your changes.

Commit Guidelines

  • Keep your commits focused and atomic, addressing a single issue or adding a specific feature.
  • Provide clear and concise commit messages that describe the purpose of the changes.
  • If your commit fixes a known issue, reference it using the appropriate keywords (e.g., "Fixes #123").

Submitting a Pull Request

  • Make sure your changes are based on the latest code in the main branch.
  • Provide a clear and descriptive title for your pull request.
  • Include a summary of the changes made and the motivation behind them.
  • Mention any related issues by linking them using the appropriate keywords (e.g., "Closes #456").
  • Be responsive to any feedback or change requests during the review process.

Your help is greatly appreciated.