Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

77 lines (59 loc) · 3.6 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! We welcome all contributions and appreciate your time and effort. Please take a moment to read and follow these guidelines before you get started.

Getting Started

To get started with contributing to our project, please follow these steps:

  1. Clone the repository locally.
  2. Install the necessary dependencies by running yarn install.
  3. Create a new branch based on develop branch for your changes. The branch name should start with one of the following prefixes, depending on the type of changes you are making:
    • feat/ for new features
    • fix/ for bug fixes
    • docs/ for documentation changes
    • style/ for changes that do not affect the meaning of the code (e.g. formatting)
    • refactor/ for code changes that neither fix a bug nor add a feature
    • perf/ for code changes that improve performance
    • test/ for adding missing tests or correcting existing tests
  4. Make your changes and commit them using Conventional Commits.
  5. Push your changes to the main repository.
  6. Create a pull request to merge your changes into the develop branch.

Conventional Commits

We use Conventional Commits to standardize our commit messages. Please follow the guidelines below when making your commits:

  1. Use the following format for your commit messages: <type>(<scope>): <subject>.
  2. The must be one of the following:
    • feat: a new feature
    • fix: a bug fix
    • docs: documentation changes
    • style: changes that do not affect the meaning of the code (e.g. formatting)
    • refactor: code changes that neither fix a bug nor add a feature
    • perf: code changes that improve performance
    • test: adding missing tests or correcting existing tests
  3. The <scope> is optional and should be used to specify which part of the project your commit affects.
  4. The <subject> should be a short description of the change.

Code Style

We use Tailwind CSS for our styling and NextJS for our frontend development. Please follow these guidelines when writing your code:

  1. Use Tailwind CSS for styling whenever possible.
  2. Follow the NextJS documentation for code style and structure.

Pull Request Template

Please use the following template when submitting a pull request:

## Description
[Provide a brief description of what this pull request does and what changes it introduces]

## Related Issue
[If this pull request relates to a specific issue or feature request, add the issue number or link to it here]

## What I did
[Describe in detail what you did to accomplish the goals of this pull request]

## Checklist
Please mark the items that apply to this pull request:
- [ ] Added new functionality
- [ ] Fixed a bug
- [ ] Improved existing functionality
- [ ] Refactored code
- [ ] Updated documentation
- [ ] Other (please describe below)

## Additional Details
[If you selected "Other" in the checklist, please describe what you did here]

## Screenshots (if applicable)
[If your changes include any visual changes, please include screenshots or animated GIFs to demonstrate them]

Conclusion

Thank you for taking the time to read and follow our contribution guidelines. Your contributions are valuable to us and we appreciate your efforts to make our project better. If you have any questions or concerns, please don't hesitate to reach out to our team for support.

Happy contributing!