Contributing

Contributing

Contributions to JavaFXSmartGraph are welcome! Whether it's bug reports, feature requests, documentation improvements, or code contributions, your help is appreciated.

Reporting Issues

• Use the GitHub Issues tracker to report bugs or request features.
• Before creating a new issue, please check if a similar one already exists.
• When reporting a bug, include:
  • A clear and concise description of the problem.
  • Steps to reproduce the bug.
  • Expected behavior and actual behavior.
  • JavaFXSmartGraph version, Java version, and OS.
  • Relevant code snippets or a minimal reproducible example, if possible.

Pull Requests

1. Fork the Repository: Create your own fork of the JavaFXSmartGraph repository.
2. Create a Branch: Create a new branch in your fork for your changes (e.g., git checkout -b feature/my-new-feature or fix/bug-fix-description).
3. Make Your Changes: Implement your feature or bug fix.
   • Adhere to the existing code style.
   • Add Javadoc for new public methods and classes.
   • Consider adding unit tests for new functionality.
4. Test Your Changes: Ensure your changes work as expected and do not introduce regressions.
5. Commit Your Changes: Use clear and descriptive commit messages.
6. Push to Your Fork: Push your changes to your branch on your fork (git push origin feature/my-new-feature).
7. Submit a Pull Request: Open a pull request from your branch to the master branch (or the relevant development branch) of the original JavaFXSmartGraph repository.
   • Provide a clear description of the changes in your pull request.
   • Reference any related issues.

Code Style

Please try to follow the existing code style and formatting used in the project.

Questions

If you have questions about the codebase or a potential contribution, feel free to open an issue to discuss it.

Thank you for contributing!