Before creating an Issue for features/bugs/improvements please follow these steps:
- search existing Issues before creating a new issue (has someone raised this 1.already)
- if it doesn't exist create a new issue giving as much context as possible (please select the correct Issue type, for example bug or feature)
Before working on an existing Issue please follow these steps:
- only ask to be assigned 1 issue at a time
- comment asking for the issue to be assigned to you
- after the Issue is assigned to you, you can start working on it
- only start working on this Issue (and open a Pull Request) when it has been assigned to you - this will prevent confusion, multiple people working on the same issue and work not being used
- while making a pr make sure to add screenshots about the result after fixing the assigned issue
When making commits to this project, please follow the following format based on the type of change:
-
Feature: Use the format
feat -- [description]for feature-related commits. Example:feat -- Added a new user authentication system. -
Bug Fix: Use the format
bug -- [description]for bug fix-related commits. Example:bug -- Fixed a critical issue causing data loss. -
Styling: Use the format
style -- [description]for commits related to code styling changes. Example:style -- Improved code formatting and indentation. -
Setup: Use the format
setup -- [description]for commits related to changes in components or directory structure. Example:setup -- Refactored the components directory for better organization.
Please ensure that your commit messages are concise, descriptive, and provide a clear understanding of the changes made in each commit.