Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

83 lines (50 loc) · 2.92 KB

Contributing to Sprint Web Framework

Thank you for your interest in contributing to Sprint! We appreciate your help in making this web framework better. By contributing, you can help us improve features, fix bugs, and enhance documentation.

How to Contribute

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on our GitHub repository. When reporting issues, please provide the following details:

  • A clear and concise title and description.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Environment details (e.g., operating system, Go version).

Code Contributions

If you'd like to contribute code to Sprint, please follow these steps:

  1. Fork the repository to your own GitHub account.

  2. Clone the forked repository to your local development environment.

    git clone https://github.com/zlorgoncho1/sprint.git

  3. Create a new branch for your work.

    git checkout -b feature/your-feature-name

  4. Make your changes and ensure that the code follows the project's coding standards.

  5. Write tests for new features and ensure that existing tests pass.

  6. Commit your changes with clear, descriptive messages.

    git commit -m "Add feature: Your feature description"

  7. Push your changes to your forked repository.

    git push origin feature/your-feature-name

  8. Create a pull request (PR) on the main Sprint repository. Be sure to include a detailed description of the changes you've made.

Documentation Contributions

Contributions to documentation are highly valuable. If you want to improve documentation, follow these steps:

  1. Fork the repository and clone it to your local environment, as mentioned above.

  2. Locate the documentation files you want to update or add, and make the necessary changes.

  3. Commit your changes and push them to your forked repository.

  4. Create a pull request with a clear description of your documentation changes.

Coding Standards

To maintain code consistency, please adhere to the following coding standards:

  • Follow Go's official coding style.
  • Use meaningful variable and function names.
  • Write clear and concise comments.
  • Format your code using gofmt or any other code formatter.
  • Keep your code DRY (Don't Repeat Yourself).

Code Review

All code changes will be reviewed by the maintainers and other contributors. We will provide feedback and suggestions for improvement. Be prepared to address any issues or comments related to your contribution.

License

By contributing to Sprint, you agree that your contributions will be licensed under the MIT License that governs this project.

Thank You!

Your contributions help us make Sprint a better web framework for the Go community. We appreciate your efforts in making this project successful.