Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.38 KB

File metadata and controls

50 lines (32 loc) · 1.38 KB

Contributing to JSONAPI

Thanks for considering contributing! Here are some guidelines to help you get started.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. Please adhere to this code in all interactions.

How to Contribute

Reporting Bugs

  • Search existing issues to avoid duplicates.
  • Create a new issue with a clear title and detailed description.
  • Include steps to reproduce, expected behavior, and screenshots if applicable.

Suggesting Enhancements

  • Search existing issues for similar suggestions.
  • Create a new issue with a clear title and detailed description.
  • Explain the problem and the proposed solution.

Pull Requests

  1. Fork the repository.
  2. Clone your fork and create a new branch.
  3. Commit your changes with a descriptive message.
  4. Push your branch to your fork.
  5. Open a pull request against the main branch.

Style Guides

Commit Messages

  • Use present tense (e.g., "Add feature" not "Added feature").
  • Be concise and descriptive.
  • Reference issues and pull requests when relevant.

Code Style

  • Follow the project's coding conventions.
  • Ensure your code passes all tests.

Additional Notes

  • Use issue labels to categorize your issue or pull request.
  • Engage in discussions and provide feedback.

Thank you for your contributions!