First off, thanks for taking the time to contribute!
The following is a set of guidelines for contributing to Circle and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Circle Code of Conduct. By participating, you are expected to uphold this code.
- Node.js (LTS version recommended)
- npm or yarn
- Git
- Clone the repo:
git clone https://github.com/MDF05/circle.git - Navigate to the folder:
cd circle - Install dependencies for both backend and frontend.
This section guides you through submitting a bug report.
- Use the Issues tab: Check if the bug is already reported.
- Clear Title and Description: Explain what happened and what you expected to happen.
- Reproduction Steps: Provide step-by-step instructions to reproduce the bug.
- Feature Request: specific improvements or new features.
- Explain: Why you want this feature and how it benefits the project.
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Update documentation if relevant.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally after the first line.
- We use ESLint and Prettier to enforce code style.
- Run
npm run lintbefore committing. - Prefer functional components for React.
- Use
constoverlet.
- Use Markdown.
- Keep it concise and clear.