Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

60 lines (45 loc) · 2.13 KB

Contributing to CRUD Panel Generator for JavaFX

First off, thanks for taking the time to contribute! This project is open-source, and we appreciate your interest in improving it.

How Can I Contribute?

Reporting Bugs

If you find a bug, please report it by opening an issue on GitHub. Include as much detail as possible:

  • Steps to reproduce the issue.
  • Your environment (operating system, JDK version, etc.).
  • Any relevant logs or error messages.

Suggesting Enhancements

Have an idea to improve the project? We'd love to hear it! Open an issue with the "enhancement" label, and describe your suggestion in detail.

Submitting Pull Requests

  1. Fork the repository: Fork the repo on GitHub and clone it to your local machine.

    git clone https://github.com/saulhidalgoaular/javafx-crud-generator.git
    cd javafx-crud-generator 
    
  2. Create a new branch: Create a new feature or bugfix branch from the main branch.

    git checkout -b feature/my-feature
    
  3. Make your changes: Implement your changes in the new branch. Make sure to follow the project's coding style and conventions.

  4. Commit your changes: Write clear and concise commit messages.

    git add .
    git commit -m "Add new feature X"
    
  5. Push to your fork: Push your changes to your fork on GitHub.

    git push origin feature/my-feature
    
  6. Submit a pull request: Go to the original repository on GitHub and open a pull request from your branch. Describe your changes in detail and reference any related issues.

Coding Standards

  • Follow Java naming conventions.
  • Keep your code clean and well-documented.
  • Write unit tests for new features and bug fixes.

Resources

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Contact

If you have any questions, feel free to reach out to the maintainers at saulhidalgoaular@gmail.com.

Thank you for your contributions!