Skip to content

Latest commit

 

History

History
55 lines (28 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

55 lines (28 loc) · 2.72 KB
Raw

Contributing to Gostein

Welcome to the Gostein project! We're glad you're interested in contributing.

How to Contribute

There are many ways to contribute to Gostein:

  • Bug Reports: If you find a bug, please open an issue and describe the problem as clearly as possible. Include any relevant information that might help us reproduce the bug.

  • Feature Requests: If you have an idea for a new feature, please open an issue and describe the feature you'd like to see. Explain why it would be useful and provide any additional information you think might be helpful.

  • Pull Requests: If you'd like to contribute code to Gostein, please submit a pull request. Make sure your code follows our coding guidelines and has test coverage. We'll review your code as soon as possible and provide feedback.

Getting Started

To get started contributing to Gostein, follow these steps:

  1. Fork the repository: Fork Gostein by clicking the "Fork" button in the upper right-hand corner of the repository page.

  2. Clone the repository: Clone your fork of the repository to your local machine using git clone https://github.com/YOUR_USERNAME/gostein.git.

  3. Create a branch: Create a new branch for your changes using git checkout -b my-branch-name.

  4. Make changes: Make your changes to the codebase. Be sure to follow our coding guidelines and add tests if necessary.

  5. Commit your changes: Commit your changes using git commit -m "Description of changes".

  6. Push changes: Push your changes to your fork using git push origin my-branch-name.

  7. Open a pull request: Open a pull request by clicking the "New pull request" button on the repository page. Be sure to describe your changes in detail and reference any relevant issues.

Code of Conduct

Please note that we have a Code of Conduct and we expect all contributors to abide by it. The Code of Conduct can be found in the CODE_OF_CONDUCT.md file in the repository.

Contributor License Agreement

By contributing to Gostein, you agree to license your contributions under the project's license.

Testing

Gostein uses the standard Go testing package for testing. To run the tests, use the go test command.

Code Style

Gostein follows the official Go code style guidelines as described in the Effective Go document. Please make sure your code follows this style guide before submitting a pull request.

Documentation

Please make sure to document any changes you make to the codebase. This includes updating the README.md file, as well as adding inline comments where necessary.

Feedback

We welcome feedback and suggestions for improvement. Please feel free to open an issue or contact the project maintainers if you have any feedback or suggestions.