Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
63 lines (39 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.04 KB

Contributing to go-initializer

Thank you for your interest in contributing to this project! We welcome contributions from everyone. Please take a moment to review this document to understand our guidelines and processes.

How Can I Contribute?

Reporting Bugs

  • Use GitHub Issues to report bugs.
  • Please include a clear and descriptive title, steps to reproduce, expected and actual behavior, and any relevant logs or screenshots.

Suggesting Enhancements

  • Open an issue to suggest new features or improvements.
  • Describe your suggestion in detail and explain why it would be beneficial.

Pull Requests

  • Fork the repository and create your branch from main.
  • Write clear, concise commit messages.
  • Ensure your code follows the project's style guidelines.
  • Add tests for new features or bug fixes.
  • Run all tests locally before submitting.
  • Submit your pull request and fill out the PR template.
  • Reference any related issues in your PR description.

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.

Style Guide

  • Follow the language-specific style guides (Go, TypeScript, etc.).
  • Use descriptive variable and function names.
  • Document public methods and exported functions.

Development Setup

Backend (Go)

  • Ensure you have Go installed (see go.dev).
  • Run go mod tidy to install dependencies.
  • Use go fmt to format your code.

Frontend (React)

  • Ensure you have Node.js and npm installed.
  • Run npm install in the frontend/ directory.
  • Use npm run lint to check code style.

Commit Message Guidelines

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Questions?

If you have any questions, open an issue or contact the maintainers.