Skip to content

Latest commit

 

History

History
41 lines (21 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

41 lines (21 loc) · 2.31 KB

Contributing to SQL Parser (Golang)

Thank you for considering contributing to the SQL Parser project written in Golang. Your contributions are valuable, and we appreciate your help in making this project better. Please take a moment to read through this document to understand how you can contribute to the project.

Getting Started

To start contributing, follow these simple steps:

  1. Fork the repository: Click the "Fork" button on the top right of the project's repository page, and clone your fork to your local machine.

  2. Create a new branch: Make a new branch for your contributions. Branch names should be clear and descriptive of the changes you plan to make (e.g., feature/issue-123 or fix/issue-456).

  3. Install dependencies: Make sure you have all the necessary dependencies installed to build and test the project.

  4. Make your changes: Implement your changes or fixes, keeping in mind the project's coding style and guidelines.

  5. Test your changes: Run tests to ensure that your changes haven't introduced any new issues and that the existing tests pass.

  6. Commit your changes: Commit your changes with a clear and concise message. Your message should start with a verb in the present tense (e.g., "Add feature," "Fix issue," "Update documentation").

  7. Push your changes: Push your changes to your forked repository.

  8. Submit a pull request: Go to the original project repository and click the "New Pull Request" button. Provide a clear description of your changes, why they are necessary, and any relevant information that could help the maintainers review your pull request.

Code Style and Guidelines

We follow these guidelines when writing code for this project:

  • Use Golang's official code style and adhere to the project's coding conventions.

  • Write clear and concise code comments.

  • Use descriptive variable and function names.

  • Write unit tests for your code, ensuring they pass before submitting a pull request.

  • Keep your changes focused and specific, addressing a single issue or feature.

Reporting Issues

If you discover a bug or have an idea for an enhancement, please report it by creating an issue on the project's GitHub repository. Make sure to provide a detailed description, including the steps to reproduce the issue.