Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (35 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 1.96 KB

Contributing

Thank you for your interest in contributing! We welcome contributions from the community. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/opensraph/template.go.git

  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature/your-feature-name

  4. Make Changes: Implement your changes. Ensure that your code adheres to the project's coding standards.

  5. Run Tests: Before submitting your changes, run the tests to ensure everything works as expected.

    make test

  6. Commit Your Changes: Use conventional commits to describe your changes. For example:

    git commit -m "feat: add new feature"

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

    git push origin feature/your-feature-name

  8. Create a Pull Request: Go to the original repository and create a pull request from your branch. Provide a clear description of your changes and why they are needed.

Coding Standards

  • Follow the Go Code Review Comments for coding style.
  • Ensure your code is well-documented and includes comments where necessary.
  • Maintain consistent formatting by using the provided .editorconfig file.

Issues and Feature Requests

If you encounter any issues or have suggestions for new features, please open an issue in the repository. Provide as much detail as possible to help us understand the problem or suggestion.

License

By contributing to this project, you agree that your contributions will be licensed under the project's LICENSE.

Thank you for contributing! We appreciate your help in making My Go Project better.