Thank you for contributing to Hurricane. Here I have listed the contributing guidelines for this project.
Please abide by the Code of Conduct.
This project uses yarn as its package manager.
To install yarn:
npm i -g yarnTo request a feature or notify about a bug, please open an issue at https://github.com/AviAvinav/Hurricane/issues.
To contribute to the codebase:
- Look for an open issue or create one if you find a bug.
- Fork the repo & make changes
- Open a pull request for the issue
- In case of requesting a new feature, first wait for it to be approved before starting to work on it.
- Now wait for the pull request to be merged.
There is no hard and fast rule on git messages, they should just be descriptive of what you have done.
Hurricane uses husky and lint-staged to check for any errors related to eslint and prettier. If the commit fails please fix it with yarn fix.
This project uses Eslint to find errors and Prettier for styling.
Use camelCase for file names and snake_case for directory names.