Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (21 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

32 lines (21 loc) · 1.89 KB
Raw

Contributing to Age Go Driver

We welcome contributions from the community to help improve and enhance this Go driver for Apache AGE. Your involvement is valuable in making this project even better!

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.
  2. Create a Branch: Create a new branch for your changes. Use a descriptive name that reflects the changes you're making (e.g., feature/add-new-feature or bugfix/fix-issue).
  3. Make Changes: Make your desired changes to the codebase. Ensure your code follows the project's coding conventions and style.
  4. Write Tests: If applicable, write tests to ensure your changes work as expected and do not introduce regressions.
  5. Commit Changes: Commit your changes with clear and concise commit messages.
  6. Push Changes: Push your changes to your forked repository.
  7. Open a Pull Request: Open a pull request against the main repository. Explain the changes you've made, why they are necessary, and how they improve the project.

Coding Guidelines

  • Go Formatting: Follow the standard Go formatting conventions. You can use go fmt to automatically format your code.
  • Error Handling: Handle errors gracefully and provide informative error messages.
  • Testing: Write comprehensive tests to cover your code changes.
  • Documentation: Update the documentation to reflect any changes you make.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on the repository. Be sure to provide a clear description of the issue, steps to reproduce it, and any relevant information.

Code of Conduct

We expect all contributors to follow our Code of Conduct. Please be respectful and considerate towards others.

License

By contributing to this project, you agree that your contributions will be licensed under the Apache License 2.0.