Skip to content

Latest commit

 

History

History
97 lines (63 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

97 lines (63 loc) · 2.99 KB

Contributing to Stock-Backend

First off, thank you for considering contributing to the Stock-Backend project! Your support and contributions are highly appreciated.

Table of Contents

Getting Started

To start contributing:

  1. Fork the repository on GitHub.

  2. Clone your fork to your local machine:

    git clone /~https://github.com/your-username/stock-backend.git

  3. Set up the development environment by following the instructions in the README.md file.

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

    git checkout -b feature/your-feature-name

How to Contribute

Reporting Bugs

If you encounter a bug or have a question, please open an issue and provide as much detail as possible. Include steps to reproduce the issue and any relevant logs or screenshots.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please open an issue with the [Enhancement] tag and describe your idea in detail.

Pull Requests

Before submitting a pull request:

  1. Ensure your code passes all tests and follows the project's coding standards.
  2. Update documentation as necessary.
  3. Reference any related issues in your pull request description.
  4. Ensure your pull request has a clear and descriptive title.

To submit a pull request:

  1. Push your changes to your forked repository:

    git push origin feature/your-feature-name

  2. Go to the original repository and click on New Pull Request.

  3. Fill out the pull request template and submit.

Development Guidelines

Code Style

  • Follow the Go coding standards.
  • Use meaningful variable and function names.
  • Write comments for complex logic and public functions.
  • Format your code using go fmt.

Commit Messages

  • Use the imperative mood in your commit messages (e.g., "Add feature," not "Added feature").
  • Start with a short summary (50 characters max).
  • Include a detailed description if necessary.
  • Reference issues by number (e.g., Fixes #123).

Community Guidelines

  • Be respectful and considerate in your interactions.
  • Provide constructive feedback.
  • Follow the project's Code of Conduct (if available).

License

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

Thank you for your interest in improving Stock-Backend! Together, we can make it better.