Skip to content

Contributing

_Coho04_ edited this page Jun 19, 2024 · 2 revisions

We welcome contributions to the GithubAPI project! Whether you're fixing bugs, adding new features, or improving documentation, your help is appreciated.

How to Contribute

  1. Fork the Repository

    • Click the "Fork" button at the top right of the repository page.
  2. Clone Your Fork

    • Clone your fork to your local machine:
      git clone https://github.com/your-username/GithubAPI.git
  3. Create a Branch

    • Create a new branch for your feature or bugfix:
      git checkout -b my-feature-branch
  4. Make Your Changes

    • Make the necessary changes in your local repository.
  5. Commit Your Changes

    • Commit your changes with a descriptive commit message:
      git commit -m "Description of my changes"
  6. Push to Your Fork

    • Push your changes to your forked repository:
      git push origin my-feature-branch
  7. Submit a Pull Request

    • Go to the original repository and click the "New Pull Request" button.
    • Ensure your pull request description clearly explains the changes and references any relevant issues.

Guidelines

  • Code Style: Follow the project's coding style and conventions.
  • Testing: Ensure that your changes pass existing tests and add new tests if necessary.
  • Documentation: Update documentation to reflect your changes.

Reporting Issues

If you find a bug or have a feature request, please open an issue in the issue tracker.

Thank you for your contributions!

For more detailed guidelines, refer to the Contributing Guide.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Contact

For any questions or help, feel free to contact us at [email protected].

Clone this wiki locally