Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.94 KB

Contributing to jsontr.ee

Thank you for your interest in contributing to JSONtr.ee! This document provides guidelines to help make the contribution process smooth and effective.

How to Contribute

1. Reporting Issues

If you encounter a bug or have an idea for a new feature, please open an [issue] in the repository. Be sure to provide the following information:

  • Description of the problem: Clearly explain the issue you are experiencing.
  • Steps to reproduce: Include the steps that need to be followed to reproduce the problem.
  • Expected behavior: Describe what you expected to happen.

2. Pull Requests

If you want to contribute code, please follow these steps:

  1. Fork the Repository: Create a fork of this repository to your GitHub account.
  2. Create a New Branch: Create a new branch for your feature or bug fix. Use a descriptive name for the branch:
git checkout -b your-branch-name
  1. Make Changes: Make your changes in the new branch.
  2. Testing: Ensure your code is well tested. If possible, include tests for any new functionality you add.
  3. Commit Changes: Commit your changes with a clear and descriptive message:
git commit -m "Description of the changes made"
  1. Push to Your Fork: Push your changes to your fork:
git push origin your-branch-name
  1. Create a Pull Request: Go to the original repository and create a pull request from your branch. Be sure to describe the changes you made and why they are necessary.

3. Code Standards

  • Code Style: Follow the existing code style in the project.
  • Documentation: If you add new functionalities, make sure to update the corresponding documentation.
  • Clean Code: The code should be clean and free of errors. Use a linter if possible.

Questions

If you have questions about how to contribute, feel free to open an issue or contact me at X.

Thank you for contributing to jsontr.ee!