Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 2 KB
Raw

Contribution Guidelines

Thank you for contributing to our project! Please follow these guidelines before submitting a pull request (PR).

  • If you have any suggestions for the projects, like reporting a bug, improving UI/UX, or enhancing the README.md file, feel free to open an issue to discuss it.
  • Please ensure your pull request adheres to good practices and standards.
  • Pleae ensure your pull request have reference to the issue assigned.
  • Please make sure you check your spelling and grammar.
  • Create individual Pull Requests for each issues.

Setup Instructions

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install or yarn install, depending on your package manager.
  3. Set up any necessary configuration files (if applicable).

Code Guidelines

  1. Write clear and concise code with meaningful variable names and comments where necessary.
  2. Ensure backward compatibility and avoid breaking changes.

Testing Procedures

  1. Run unit tests using npm test or yarn test to ensure new code passes all tests.
  2. Include test cases for new features or bug fixes.
  3. Perform manual testing if applicable, especially for UI changes.

PR Guidelines

  1. Create a new branch for your changes (git checkout -b #issue number).
  2. Reference the related issue in your PR description using the format Fixes #issue_number.
  3. Provide a clear and detailed description of your changes.
  4. Include screenshots or GIFs for UI changes if relevant.
  5. Update documentation if your changes impact existing documentation.

Review Checklist

  1. Complete code review and address any feedback.
  2. Ensure all tests pass, and new code doesn't introduce regressions.
  3. Double-check code formatting, naming conventions, and documentation.
  4. Verify that your PR meets the project's acceptance criteria.

Contact Information

If you have any questions or need assistance, you contact me on https://discord.gg/UAC2Ys2m or open an issue for discussion.

We appreciate your contributions to the project!