Thank you for considering contributing to Rulefy! This document provides guidelines and instructions for contributing.
By participating in this project, you agree to abide by its Code of Conduct.
- Check if the bug has already been reported in the Issues section
- Use the bug report template to create a new issue
- Include detailed steps to reproduce the bug
- Include your environment details (OS, Node.js version, etc.)
- Check if the enhancement has already been suggested in the Issues section
- Use the feature request template to create a new issue
- Describe the enhancement in detail and explain why it would be useful
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests and linting (
npm test && npm run lint) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Clone the repository
- Install dependencies:
npm install - Build the project:
npm run build - Run tests:
npm test
- 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
- Use 2 spaces for indentation
- Use semicolons
- Follow the ESLint configuration
- Use Markdown for documentation
- Reference examples when possible
By contributing, you agree that your contributions will be licensed under the project's MIT License.