Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
129 lines (100 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

129 lines (100 loc) · 4.68 KB

Contributing to l3-react-blocks-construct

Thank you for your interest in contributing to l3-react-blocks-construct! Your contributions help improve this project for everyone. Whether you're reporting a bug, suggesting an enhancement, or submitting code changes, we welcome your input.

Table of Contents

Code of Conduct

Please read and follow our Code of Conduct. By participating in this project, you agree to abide by its terms.

How to Contribute

Reporting Issues

If you encounter a bug or any issue, please report it by opening an issue and include the following details:

  • Description: A clear and concise description of the bug.
  • Steps to Reproduce: Steps to replicate the issue.
  • Expected Behavior: What should happen.
  • Actual Behavior: What actually happens.
  • Screenshots: If applicable, attach screenshots.
  • Environment: Specify OS, browser, and versions.
  • Type: Select type Bug
  • Project: Select Project Blocks Construct

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.
  2. Clone Your Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/your-username/l3-react-blocks-construct.git
cd l3-react-blocks-construct
  3. Create a Branch: Create a new branch for your feature or bugfix. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your changes in the codebase.
  5. Commit Changes: Follow the Git Guidelines for commit messages.
  6. Push to GitHub: Push your changes to your forked repository. 
    git push origin feature/your-feature-name
  7. Open a Pull Request: Navigate to the original repository and click "New Pull Request".

Branching Strategy

We follow Git Flow for branching:

  • main: Production-ready code.
  • dev: Active development branch.
  • feature/*: New features branching from dev.
  • bugfix/*: Bug fixes branching from dev.
  • hotfix/*: Emergency fixes branching from main.

Git Guidelines

  • Use the Imperative Mood: Start commit messages with a verb in the imperative mood (e.g., "add", "fix", "update", "remove").
  • Keep Messages Short and Descriptive: The subject line should be concise (50 characters or less) and clearly describe the change.
  • Separate Subject from Body: If more detail is needed, separate the subject from the body with a blank line. The body should explain the "what" and "why" of the changes.
  • Lowercase Commit Message: Keep the commit message in lowercase.
  • Avoid Ending with a Period: Do not end the subject line with a period.
  • Reference Issues and Pull Requests: Reference related issues or pull requests in the body of the commit message (e.g., "fixes #123" or "see pr #456").
  • Use Conventional Commits: Follow the Conventional Commits specification for a standardized commit message format. Types include feat, fix, docs, style, refactor and test.

Example of a well-structured commit message:

feat(auth): add user authentication - issue(#423)

- implement JWT-based authentication
- add login and registration endpoints
- update user model to include password hashing

Coding Guidelines

  • Formatting: Use Prettier. Format your code with: 
    npm run format
  • Linting: Run the linter before submitting changes: 
    npm run lint
  • Testing: Ensure all tests pass before submitting a PR: 
    npm test

Code Review Process

All PRs undergo review to maintain quality. Review steps:

  1. PR Submission: Ensure PRs are small and well-documented.
  2. Automated Checks: CI/CD will run tests and linting.
  3. Peer Review: At least one maintainer must approve the PR.
  4. Merge Process: Once approved, the PR is merged into dev.

Development Setup

  1. Install Dependencies: 
    npm install
  2. Start the Development Server: 
    npm start
  3. Run Tests: 
    npm test

License

By contributing, you agree that your contributions will be licensed under the MIT License.