Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

92 lines (70 loc) · 3.29 KB




Website   •   Docs   •   Sample Application   •   X   •   Discord


Contribution Guide

Thank you for considering contributing to this project! We welcome contributions that help improve the project, whether through bug reports, feature suggestions, or code contributions. Please take a moment to review this guide to make the process smooth and collaborative.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button on the top-right corner of the repository page to create a personal copy.

  2. Clone the Repository

    • Clone your fork to your local machine using the following command: 
      git clone https://github.com/apitraffic/apitraffic-express.git
cd apitraffic-express

  3. Create a Branch

    • Use a descriptive name for your branch to indicate the feature or bug fix. For example: 
      git checkout -b feature/add-new-functionality

  4. Make Your Changes

    • Add or update code, documentation, or assets. Ensure your changes align with the project’s coding style and conventions.

  5. Test Your Changes

    • Run existing tests and add new ones if necessary to ensure your changes work as expected.

  6. Commit Your Changes

    • Write clear and concise commit messages. For example: 
      git add .
git commit -m "Fix: Correct issue with API response handling"

  7. Push to Your Fork

    • Push your changes to the branch in your fork: 
      git push origin feature/add-new-functionality

  8. Create a Pull Request (PR)

    • Go to the original repository and click on the "Pull Requests" tab.
    • Click "New Pull Request," select your branch, and provide a detailed description of your changes.

Contribution Guidelines

  • Documentation: Update or create relevant documentation for your changes.
  • Issue Reference: Link your pull request to an open issue (if applicable) using keywords like Fixes #123.
  • Review Process: Be prepared to update your pull request based on feedback.

Reporting Issues

If you encounter a bug or have a suggestion, open an issue in the repository. Provide as much detail as possible, including steps to reproduce the issue or your proposed solution.

Need Help?

Feel free to reach out on Discord to discuss any ideas or challenges you are having.

We appreciate your efforts in making this project better! 🎉