Skip to content

Latest commit

聽

History

History
44 lines (31 loc) 路 2.13 KB

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) 路 2.13 KB
Raw

Contributing to go-hands-on-tutorial

Welcome to the go-hands-on-tutorial repository! We're excited that you're interested in contributing to our project. Before you get started, please take a moment to read through this guide to understand how you can contribute effectively and maintain the quality of the project.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Run the ./run.sh <new_module_name> script in the root directory with the desired module name. This will initialize a module in the tutorial directory and create an entry in the readme.
  4. Make sure your code is well-tested and follows the coding standards of the project.

Contributing Guidelines

  • Ensure that your code is well-tested and follows best practices.
  • Write clear and concise commit messages.
  • If you're adding a new module:
    • Create the necessary files in the tutorial directory.
    • Update the README.md file with information about the new module.
    • Make sure the logic.md file in the module is well-written and easy to understand.
  • If you're fixing a bug or adding a feature:
    • Create a new branch for your contribution.
    • Submit a pull request (PR) to the main branch of the main repository.

Pull Request Process

  1. Create a new branch from the main branch.
  2. Commit your changes with clear messages.
  3. Push your changes to your forked repository.
  4. Open a pull request against the main branch of the main repository.
  5. Provide a detailed description of your changes in the pull request.
  6. Participate in the code review process by addressing any feedback or comments.

Licensing

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

Thank you for your interest in contributing to go-hands-on-tutorial! Your efforts help to grow and improve the project.

If you have any questions or need assistance, feel free to reach out in the discussions or by opening an issue.

Happy coding!

Created by Prakhar Rai. All rights & content for this project are held by Prakhar Rai.