Skip to content

Latest commit

 

History

History
115 lines (68 loc) · 4.53 KB

CONTRIBUTING.md

File metadata and controls

115 lines (68 loc) · 4.53 KB
Raw

Contributing to My Image Fetcher Library

Thank you for considering contributing to My Image Fetcher Library! By contributing, you help improve the library and make it more valuable for others. Please take a moment to review this document to understand how you can contribute effectively.

Table of Contents

  1. How Can I Contribute?
  2. Getting Started
  3. Coding Guidelines
  4. Testing
  5. Commit Messages
  6. License

How Can I Contribute?

There are several ways you can contribute to this project:

Reporting Bugs

If you encounter any issues or bugs while using the library, please open a new issue on GitHub. Be sure to provide as much detail as possible, including the steps to reproduce the issue and your environment.

Suggesting Enhancements

If you have ideas for enhancements or new features, please create an issue on GitHub to discuss your proposal. We welcome your input and feedback.

Submitting Pull Requests

If you would like to contribute code to the project, follow these steps:

  1. Fork the repository.
  2. Clone your fork to your local machine.

Setting Up Your Development Environment

Make sure you have the necessary tools and dependencies installed. Refer to the README.md for instructions on setting up your development environment.

Building the Project

Follow the build instructions in the README.md to build the project locally.

Coding Guidelines

Adhere to the coding guidelines specified in the Coding Guidelines section below.

Testing

Ensure that your changes do not break existing functionality. Write tests if necessary to cover your changes.

Commit Messages

Write clear and concise commit messages. Follow the Commit Messages guidelines below.

  1. Push your changes to your fork.

  2. Create a pull request (PR) from your fork to the main branch of this repository.

  3. Provide a clear and detailed description of your changes in the PR.

  4. Await feedback and be prepared to address any reviewer comments or requests for changes.

Once your PR is approved and merged, you will be credited for your contribution!

Getting Started

Forking the Repository

To fork the repository, click the "Fork" button at the top right of the GitHub page.

Setting Up Your Development Environment

Before contributing, ensure you have the following prerequisites:

  • CMake
  • C++ Compiler (e.g., GCC)
  • cURL library (for making HTTP requests)

Refer to the README.md for detailed setup instructions.

Building the Project

Follow the build instructions provided in the README.md file to build the project locally.

Coding Guidelines

Please follow these coding guidelines when contributing:

  • Follow the C++ Core Guidelines.
  • Use meaningful variable and function names.
  • Keep your code concise and well-documented.
  • Format your code consistently.

Testing

Ensure that your changes do not break existing functionality. Write unit tests if necessary to validate your changes.

Commit Messages

Write clear and concise commit messages following these guidelines:

  • Use present tense ("Add feature" not "Added feature").
  • Limit the first line to 72 characters or less.
  • Include a brief and meaningful message about your changes.
  • Reference relevant issues or PRs.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Happy contributing!