Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

83 lines (54 loc) · 2.81 KB
Raw

Contributing to React-Framify

Thank you for your interest in contributing to React-Framify! We welcome contributions from everyone. By participating in this project, you agree to abide by our code of conduct.

Table of Contents

  1. Getting Started
  2. Issue Types and Branch Naming
  3. Making Changes
  4. Submitting Pull Requests
  5. Code Style
  6. Code of Conduct
  7. Contact

Getting Started

To contribute to React-Framify, please follow these steps:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your work (see Issue Types and Branch Naming for branch naming conventions).
  4. Make your changes.
  5. Push your branch to your forked repository.
  6. Submit a pull request.

Issue Types and Branch Naming

When creating an issue, please select the appropriate issue type:

  • ⚙️ Efficiency & Performance
  • ✨ Feature Request
  • 🐛 Bug Report & ⚠️ Security Vulnerability
  • 📝 Documentation
  • 🤔 Support or Usage Questions

Automated Branch Creation

We have a workflow that automatically creates branches based on the issue type and title. The branch name format is:

${type of issue}/REACT-FRAMIFY-${sanitizedIssueTitle}

Examples:

  • For a feature request titled "Add dark mode", the branch name would be: feature-request/REACT-FRAMIFY-add-dark-mode.

  • For a bug report titled "Fix memory leak", the branch name would be: bug-report/REACT-FRAMIFY-fix-memory-leak.

Note: If the branch is not automatically created or you are manually creating a branch, please follow this naming convention.

Making Changes

  1. Make sure your changes are consistent with the project's coding style (see Code Style).
  2. Include tests if applicable.
  3. Update documentation if your changes require it.

Submitting Pull Requests

When you're ready to submit your changes:

  1. Ensure your branch is up to date with the main branch.
  2. Submit a pull request to merge your changes into the main branch.
  3. Provide a clear description of the changes you made, including any relevant issue numbers.
  4. Wait for the code review and make any necessary adjustments based on feedback.

Code Style

Please follow these coding guidelines:

  • Use camelCase for variable and function names.
  • Write descriptive commit messages.
  • Format code consistently according to the project's established style.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it before contributing.

Contact

If you have any questions or need help, feel free to open an issue or contact the maintainers directly.

Thank you for contributing!