To get started, please take a moment to review the following guidelines.
- Ensure a ticket has been created for the issue/feature that you are working on.
- Create a new branch with the following format
bug|feature/GH-<#issue number>-<title of your branch>. - Make your changes in the branch.
- Write tests to cover your changes (if applicable).
- Ensure that your code follows the project's coding standards.
- Update the documentation to reflect your changes (if applicable).
- Commit your changes with a clear and concise commit message.
- Push your changes to GitHub.
- Be sure to know what branch you are merging to. Might not always be merging to
main.
We shall be following ESLint's recommended style guide.
When reporting a bug, please provide the following information:
- A clear and descriptive title.
- A detailed description of the issue, including steps to reproduce.
- Your operating system and version.
- Any relevant error messages or screenshots.
If you have a suggestion for a new feature or improvement, please provide:
- A clear and descriptive title.
- A detailed description of the proposed feature or enhancement.
- Any relevant mockups or examples.