|
| 1 | +# Contributing to xapi-cpp |
| 2 | +Thank you for your interest in contributing to **xapi-cpp**! |
| 3 | +This document outlines the guidelines for contributing, making it a smooth and collaborative experience for everyone. |
| 4 | + |
| 5 | +## How Can I Contribute? |
| 6 | + |
| 7 | +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](https://github.com/MPogotsky/xapi-cpp/issues). |
| 8 | + |
| 9 | +## Contributing Workflow |
| 10 | + |
| 11 | +1. **Fork the repository** |
| 12 | +2. **Clone the repository** |
| 13 | +3. **Create a new branch** |
| 14 | + |
| 15 | + Create a new branch for your changes. Use a descriptive branch name. |
| 16 | + ``` |
| 17 | + git checkout -b <branch-name> |
| 18 | + ``` |
| 19 | +
|
| 20 | +4. **Make your changes** |
| 21 | +
|
| 22 | + Implement your changes in the codebase. This might involve adding new features, fixing bugs, or improving documentation. |
| 23 | +
|
| 24 | +5. **Test your changes!** |
| 25 | +
|
| 26 | + Thoroughly test your changes to ensure they work as expected and don't introduce any regressions. Refer to our Testing Guidelines for specific instructions. |
| 27 | +
|
| 28 | +6. **Commit and push your changes** |
| 29 | +
|
| 30 | + Stage your changes and commit them with a clear and concise commit message. |
| 31 | + |
| 32 | + If you are solving issue from issue list, please, start you commit with #\<issue number\>. |
| 33 | +
|
| 34 | + Then, push your branch to your forked repository. |
| 35 | + ``` |
| 36 | + git add . |
| 37 | + git commit -m "#<issue number> Fix commit message" |
| 38 | + git push origin <branch-name> |
| 39 | + ``` |
| 40 | +7. **Create a pull request to master branch** |
| 41 | +
|
| 42 | + Create a pull request targeting the ```main``` branch. |
| 43 | +
|
| 44 | +8. **Wait for the pull request to be reviewed and merged** |
| 45 | +
|
| 46 | + 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. |
| 47 | + |
| 48 | + Thank you for your contribution! |
| 49 | +
|
| 50 | +
|
| 51 | +## Contact |
| 52 | +Feel free to reach out via email at matsvei.pahotski@gmail.com if you need direct assistance. |
0 commit comments