myxml is in its early stage, your contributions are crucial to its development. Before raisng an issue or creating a pull request, please take a minute to read through this guide.
There's no strict requirements for the format of an issue. However, it is important to ensure that your issue is indeed an issue. If you have any question or need clarification, please use Discussions instead of raising an issue.
All planned issues are listed in Issues. If you would like to solve one of the issue:
- Fork the repository
- Create a branch related to the issue. If a branch doesn’t already exist, feel free to create one.
- Make your commits to this branch.
Once you believe the issue is resolved, create a pull request. Please always raise an issue before creating a pull request to ensure your work aligns with the project's needs.
TL;DR
Your code should look similar to the existing code.
To maintain consistency, your code should adhere to the following guidelines:
- C++ Standard: All code should comply with the C++17 standard.
- Naming Conventions: Use CamelCase for naming methods, with public methods starting with an uppercase letter.
- Indentation: Use 4 spaces for indentation, do not use tabs.
- Consistency: Ensure your code style matches the existing codebase.
Before committing your changes, run all tests to ensure they pass. Contributions should not break existing functionality.
This Contribution Guide is also open to improvements. If you have suggestions on how to make it better, feel free to propose changes.