Skip to content

Latest commit

 

History

History
79 lines (53 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

79 lines (53 loc) · 2.37 KB

Contributing to Wraft

Thank you for your interest in contributing to Wraft! This project uses React for the frontend and follows the Git Flow workflow. Here are our guidelines for contributing.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Set up the development environment (Node.js, etc.)
  4. Create a new feature branch from the 'develop' branch
  5. Make your changes
  6. Push your changes to your fork
  7. Submit a pull request to our 'develop' branch

Development Environment

  • Node.js version: v18.0 or higher Ensure you have these versions installed before contributing.

Git Flow Workflow

We use the Git Flow branching model:

  • main: Production-ready code
  • develop: Latest delivered development changes
  • feature/*: New features
  • release/*: Preparing a new production release
  • hotfix/*: Fixing critical bugs in production Please create feature branches from develop and name them feature/your-feature-name.

Code Style

React/JavaScript

Testing

  • Write tests for React components using Jest and React Testing Library
  • Ensure all tests pass before submitting a PR

Commit Messages

  • Use clear and meaningful commit messages
  • Start with a short summary line (50 characters or less)
  • If necessary, add a blank line followed by a more detailed explanation

Pull Requests

  • Submit PRs to the develop branch
  • Provide a clear description of the changes
  • Link any relevant issues
  • Ensure all tests pass and the build is successful
  • Request review from maintainers

Reporting Bugs

  • Use the GitHub issue tracker to report bugs
  • Describe the bug in detail
  • Include steps to reproduce the bug
  • Specify your operating system and relevant software versions

Suggesting Enhancements

  • Use the GitHub issue tracker to suggest enhancements
  • Clearly describe the suggested feature and its use case
  • Be open to feedback and discussion about the suggestion

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Questions?

If you have any questions, please feel free to contact the maintainers.

Thank you for contributing to Wraft!