CONTRIBUTING.md

Contributing to xapi-cpp

Thank you for your interest in contributing to xapi-cpp! This document outlines the guidelines for contributing, making it a smooth and collaborative experience for everyone.

How Can I Contribute?

To report a bug, request a new feature, or contribute code, please use GitHub issues with the provided issue templates. You can open a new issue here.

Contributing Workflow

1. Fork the repository

2. Clone the repository

3. Create a new branch

   Create a new branch for your changes. Use a descriptive branch name.

    git checkout -b <branch-name>
   

4. Make your changes

   Implement your changes in the codebase. This might involve adding new features, fixing bugs, or improving documentation.

5. Test your changes!

   Thoroughly test your changes to ensure they work as expected and don't introduce any regressions. Refer to our Testing Guidelines for specific instructions.

6. Commit and push your changes

   Stage your changes and commit them with a clear and concise commit message.

   If you are solving issue from issue list, please, start you commit with #<issue number>.

   Then, push your branch to your forked repository.

    git add .
    git commit -m "#<issue number> Fix commit message"
    git push origin <branch-name>
   

7. Create a pull request to master branch

   Create a pull request targeting the main branch.

8. Wait for the pull request to be reviewed and merged

   Your pull request will be reviewed by project maintainers. Address any feedback or requested changes. Once approved, your pull request will be merged into the main branch.

   Thank you for your contribution!

Contact

Feel free to reach out via email at matsvei.pahotski@gmail.com if you need direct assistance.