Rehooks

Code Policy

Last Updated: January 2025

This Code Policy outlines the practices and guidelines for contributing to, using, and interacting with the Rehooks CLI project (the "Project"). By contributing to or using the Project, you agree to follow this Code Policy.

1. Licensing

Rehooks is licensed under the Apache 2.0 License. By contributing to the Project, you agree that your contributions will also be licensed under the same terms. For more information, refer to the `LICENSE` file included in the Project repository.

2. Code Standards

To maintain consistency and quality across the Project, the following standards must be adhered to:

  • Formatting: Code must follow Prettier guidelines.
  • Function Syntax: Use the `function` syntax instead of `const` when defining functions.
  • Naming Conventions: Function names must follow camelCase, and hooks must start with the prefix `use`.
  • Commenting: Avoid using comments in the code unless absolutely necessary.

3. Contribution Guidelines

  • Pull Requests: Ensure all pull requests are thoroughly tested and include clear descriptions of the changes.
  • Testing: Contributions must include tests for new features or fixes where applicable.
  • Commit Messages: Use meaningful commit messages. Follow this structure:
    • Use `feat`, `fix`, `perf`, or similar prefixes for commits.
    • Examples: `perf: optimize hook health checker`, `feat: add version compatibility checker`.

4. Security and Dependencies

  • Dependencies: Only approved libraries and tools may be added to the Project. All dependencies must be lightweight and actively maintained.
  • Security Vulnerabilities: Report any discovered vulnerabilities to [Insert Email/Contact Information]. Do not publicly disclose vulnerabilities until they are resolved.

5. Prohibited Actions

You may not:

  • Use the Project to develop or distribute malicious software.
  • Reverse-engineer or attempt to bypass Project security measures.
  • Contribute code that violates third-party intellectual property rights.

6. Changes to This Policy

Rehooks reserves the right to update this Code Policy at any time. Changes will be effective immediately upon posting. Continued use of or contributions to the Project after changes constitute acceptance of the revised Policy.

7. Contact

For questions, feedback, or to report issues, please contact Mehdi at contact@pyr33x.ir.

On this page