Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (56 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

70 lines (56 loc) · 2.36 KB
Raw

Contributing to [Project Name]

Thank you for considering contributing to [Project Name]! We welcome contributions from everyone. By participating in this project, you agree to abide by the Code of Conduct.

How to Report Bugs

If you find a bug, please help us by opening an issue on GitHub. Before creating a new issue, please search the existing issues to see if it has already been reported.

When reporting a bug, please include:

  • A clear and descriptive title.
  • Steps to reproduce the bug.
  • Expected vs. actual behavior.
  • Environment details (OS, version, language/runtime version).
  • Relevant logs or screenshots.

How to Request Features

We welcome ideas for new features or improvements. Please open an issue and use the Feature Request template. Ensure your request is clear and explains the "why" behind the feature—how it helps you or the project.

Development Setup

To get started with development, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local machine: 
    git clone https://github.com/YOUR_USERNAME/project-name.git
cd project-name
  3. Install dependencies: 
    # Example for Node.js
npm install
# Example for Python
pip install -r requirements.txt
  4. Set up environment variables (if applicable): Copy .env.example to .env and configure it as needed.
  5. Run the project: 
    npm run dev

How to Submit Pull Requests

We follow the "fork-and-pull" Git workflow:

  1. Create a branch for your feature or fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes, ensuring you follow the project's coding standards.
  3. Run tests to ensure your changes don't break existing functionality: 
    npm test
  4. Commit your changes with a descriptive commit message.
  5. Push to your fork: 
    git push origin feature/your-feature-name
  6. Open a Pull Request (PR) against the main branch of the original repository.

PR Review Process

  • Your PR will be reviewed by maintainers.
  • We may request changes before merging. Please address feedback promptly.
  • Ensure your PR is up-to-date with the main branch before requesting a final review.

Happy coding!