Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

86 lines (54 loc) · 3.59 KB
Raw

Contribution Guidelines

Welcome to PS-Go! We appreciate your interest in contributing to this project. Your contributions can help make this repository a valuable resource for the Go community. Below are the guidelines to help you get started with contributing:

Table of Contents

How to Contribute

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine:
git clone https://github.com/your-username/ps-go.git
  1. Create a new branch for your contribution:
git checkout -b feature/new-feature
  1. Make your changes, additions, or improvements to the codebase.
  2. Commit your changes with clear and descriptive commit messages.
  3. Push your changes to your forked repository:
git push origin feature/new-feature
  1. Create a Pull Request (PR) from your branch to the main branch of the original repository.

Types of Contributions

You can contribute to PS-Go in several ways:

  1. Adding New Exercises: If you have interesting programming exercises that you think will benefit others, feel free to create a new exercise folder and provide the problem statement, solution, and unit tests.

  2. Improving Existing Exercises: If you notice any issues or have suggestions for improving the existing exercises, please submit your changes or improvements.

  3. Enhancing Documentation: Clear and well-structured documentation is essential. If you find any areas that need better explanations or additional information, your documentation enhancements are highly appreciated.

  4. Bug Fixes: If you come across any bugs or errors in the code, please submit a fix or create an issue to report the problem.

Creating Issues

If you encounter any issues or have ideas for new features, you can create a GitHub issue. When creating an issue, please provide a clear and detailed description, along with any relevant code snippets or error messages.

Submitting Pull Requests

When submitting a Pull Request (PR), please follow these guidelines:

  1. Make sure your code follows the code style and standards.
  2. Clearly describe the changes made in the PR description.
  3. Reference any related issues in the PR description using GitHub's issue linking syntax (e.g., Fixes #123).

Code Style and Standards

To maintain a consistent codebase, please adhere to the following guidelines:

  1. Use descriptive variable and function names.
  2. Write clear and concise comments to explain your code.
  3. Follow the official Go formatting guidelines.
  4. Use gofmt to format your code before submitting the PR.

Commit Guidelines

Please follow the Conventional Commits specification for your commit messages. This helps in better understanding the changes made in each commit.

Attribution

Contributors will be acknowledged in the repository's Contributors file. Please include your name and GitHub profile link when submitting your PR.

License

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

Thank you for your contributions to PS-Go! Your efforts are valued and will benefit the Go community. 🚀💻