Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 2.45 KB

Contributing to the Project

First off, thank you for considering contributing to this project! Your help is greatly appreciated.

This document provides guidelines for contributing to the project. Please read it carefully to ensure a smooth and effective collaboration process.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior.

How Can I Contribute?

Reporting Bugs

If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a clear title, a description of the issue, and steps to reproduce it.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue to discuss it. This allows us to coordinate our efforts and prevent duplication of work.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through good-first-issue and help-wanted issues.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/nextjs-clean-architecture-starter.git
cd nextjs-clean-architecture-starter
  3. Install dependencies using pnpm: 
    pnpm install
  4. Create a new branch for your changes: 
    git checkout -b your-feature-name

Making Changes

  • Write clean code: Follow the existing code style and architectural patterns (Clean Architecture, DDD).
  • Add tests: Ensure that your changes are covered by tests.
  • Update documentation: If you add a new feature, make sure to update the documentation.
  • Use clear commit messages: Follow the Conventional Commits specification.

Submitting Your Contribution

  1. Push your branch to your fork on GitHub: 
    git push origin your-feature-name
  2. Open a Pull Request (PR) to the main branch of the original repository.
  3. Provide a clear description of your changes in the PR. Link to any relevant issues.
  4. Wait for a review. The maintainers will review your PR and may suggest changes.

Thank you again for your contribution!