Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 2.12 KB

Contributing to API Playground

Thank you for considering contributing to API Playground! This document provides guidelines and steps for contributing.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues to avoid duplicates. When you create a bug report, include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps to reproduce the problem
  • Describe the behavior you observed and what behavior you expected
  • Include screenshots if possible
  • Note your browser and operating system

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion:

  • Use a clear and descriptive title
  • Provide a detailed description of the proposed feature
  • Explain why this enhancement would be useful
  • List some examples of how it would be used

Pull Requests

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. Ensure the tests pass
  4. Make sure your code follows the existing style
  5. Issue the pull request!

Development Process

  1. Clone the repo: git clone https://github.com/Hamdan-Khan/API-playground.git
  2. Install dependencies: npm install
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test the changes
  6. Commit your changes: git commit -m 'Add some feature'
  7. Push to the branch: git push origin feature/your-feature-name

Style Guide

JavaScript/React

  • Use ES6+ features
  • Follow React best practices
  • Use functional components and hooks
  • Use meaningful variable and function names

Git Commit Messages

  • Use clear message ("fixed textarea length bug" not "fixed bug")

Documentation

  • Keep README.md up to date
  • Document new features
  • Update documentation if applicable

Need Help?

Feel free to ask for help in:

  • GitHub issues
  • Project discussions
  • The project's communication channels (if applicable)

License

By contributing, you agree that your contributions will be licensed under the same license that covers the project (see LICENSE).