Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.97 KB

Contributing to Go Commandline Publisher

We appreciate your interest in contributing to Go Commandline Publisher! By contributing, you not only improve the project but also help the wider community.

Bug Reports and Feature Requests

If you encounter any bugs or have ideas for new features, please create an issue on our GitHub repository. When reporting a bug, please provide detailed information about the issue, including steps to reproduce it and the expected behavior.

Pull Requests

We welcome pull requests from the community. If you want to contribute code to Go Commandline Publisher, follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch from the main branch for your changes.
  3. Make your changes in the new branch.
  4. Ensure that your changes follow the project's coding guidelines and best practices.
  5. Write tests for your changes if applicable.
  6. Run the existing tests to ensure that they pass with your changes.
  7. Commit your changes with a descriptive commit message.
  8. Push your branch to your forked repository.
  9. Open a pull request on our repository and provide a clear description of your changes.

Coding Guidelines

  • Follow the existing code style and conventions used in the project.
  • Write clear and concise code with meaningful variable and function names.
  • Ensure that your code is well-documented with comments where necessary.
  • Avoid introducing unnecessary dependencies.

Testing

  • If you add new functionality, write tests to cover that functionality.
  • Ensure that all tests pass before submitting a pull request.

Code Review

After you submit a pull request, one or more project maintainers will review your changes. We appreciate your patience during this process, and we will do our best to provide timely feedback.

License

By contributing to Go Commandline Publisher, you agree that your contributions will be licensed under the project's BSD-style license.