Issues & Pull Request

Pull Request

• Keep your changes focused and atomic, addressing one issue per PR.
• Write clear and concise commit messages and PR descriptions.
• Test your changes thoroughly and ensure they don't introduce any regressions.
• Be respectful and considerate towards other contributors.

Contribute

1. Fork the repository to your GitHub account.
2. Clone the forked repository to your local machine.
3. Create a new branch for your feature or bug fix:

git switch -c <'feature/your-feature-name'>

4. Make your changes and commit them with descriptive commit messages:

git commit -m 'feat:Add some feature'

5. Push your changes to your forked repository:

git push -u origin <'feature/your-feature-name'>

6. Open a pull request (PR) against the main repository's main branch.
7. Ensure that your PR includes a clear description of the changes made and any relevant information.
8. Our team will review your PR, provide feedback, and merge it if everything looks good.

Code Conventions

Follow the existing code style and formatting conventions.

Commit Messages

Write clear and concise commit messages and PR descriptions.

Type	Description	Example Commit message
feat	A new API or behavior for the end user.	Added a feature to allow users to upload profile pictures.
fix	A bug fix for the end user.	Resolved issue where login button was not clickable on mobile devices.
docs	A change to the website or other Markdown documents in our repo.	Updated installation guide with additional troubleshooting steps.
refactor	A change to production code that leads to no behavior difference.	Refactored code to improve readability and maintainability.
test	Adding missing tests, refactoring tests; no production code change.	Added unit tests for user authentication module.
chore	Upgrading dependencies, releasing new versions, maintenance tasks.	Updated package.json with latest dependency versions.
misc	Anything else that doesn't change production code, yet is not test or chore.	Updated GitHub Actions workflow to include code linting.

More about Conventional Commits.

Bugs

You can report documentation-related issues if you encounter any of the following:

• Undocumented API
• Need for elaboration on a particular topic
• Outdated or incorrect information
• Formatting or readability improvement

For issues related to infrastructure, please visit the Docusaurus website.

Proposals

Feature Request

For new feature or suggestion, feel free to submit a feature request