Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.64 KB

Contributing to PullCraft

We're excited that you're interested in contributing to PullCraft! This document outlines the process for contributing and sets some guidelines to ensure a smooth collaboration.

Getting Started

  1. Fork the Repository: Create your own fork of the PullCraft repository on GitHub.
  2. Clone Your Fork: git clone https://github.com/your-username/PullCraft.git
  3. Create a Branch: git checkout -b feature/your-feature-name
  4. Make Changes: Implement your feature or bug fix.
  5. Test Your Changes: Ensure your changes don't break existing functionality.
  6. Commit Your Changes: Use clear, concise commit messages.
  7. Push to Your Fork: git push origin feature/your-feature-name
  8. Open a Pull Request: Submit a PR from your fork to the main PullCraft repository.

Code Style and Standards

  • Follow the existing code style in the project.
  • Write clear, simple code.
  • Include comments for complex logic. Self-documenting code is a myth. Be explicit.
  • Write unit tests for new functionality.

Reporting Issues

  • Use the GitHub issue tracker to report bugs.
  • Clearly describe the issue, including steps to reproduce.
  • Include relevant information like OS, browser version, etc.

Pull Request Guidelines

  • Keep PRs focused on a single feature or bug fix.
  • Include a clear description of the changes. Add documentation if needed.
  • Reference any related issues in the PR description.
  • Be open to feedback and be willing to make changes if requested.

Code of Conduct

All contributors are expected to adhere to our Code of Conduct.

Thank you for contributing to PullCraft!