SDL_Graph is a extension to SDL library , it is able to render bar and line graphs ,its easy to use
We welcome contributions to the SDL_Graph project! Please follow these guidelines to ensure a smooth collaboration:
-
Start a Discussion:
- Before making any changes or adding new features, create a discussion in the repository.
- Clearly explain what you want to change or add and why it is necessary.
- Wait for feedback and approval from the maintainers before proceeding.
-
Fork the Repository:
- Once your idea is approved, fork the repository to your GitHub account.
-
Create a Branch:
- Create a new branch for your feature or bug fix.
- Use a descriptive name for your branch, such as
feature/add-line-graphorbugfix/fix-render-crash.
-
Write Clear Code:
- Follow the existing coding style and structure.
- Add comments where necessary to explain your code.
-
Test Your Changes:
- Ensure your changes do not break existing functionality.
- Add tests for new features or bug fixes if applicable.
-
Commit Messages:
- Write clear and concise commit messages.
- Use the format:
type(scope): description- Example:
feat(graph): add support for custom bar colors
- Example:
-
Submit a Pull Request:
- Push your branch to your forked repository.
- Open a pull request to the
mainbranch of this repository. - Provide a detailed description of your changes and why they are necessary.
-
Code Review:
- Be open to feedback during the code review process.
- Make necessary changes as requested by the maintainers.
-
Respect the Project Scope:
- Ensure your contributions align with the goals and scope of the project.
- If you're unsure, open an issue or discussion to clarify before starting work.
If you encounter a bug or have a feature request, please:
- Open an issue in the repository.
- Provide a clear and detailed description of the problem or feature.
- Include steps to reproduce the issue if applicable.
Please be respectful and professional in all interactions. We are committed to fostering an inclusive and welcoming environment for everyone.
Thank you for contributing to SDL_Graph!