Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

78 lines (50 loc) · 3.07 KB

Contributing to Flow

Thank you for considering contributing to flow! Whether you want to report a bug, suggest an enhancement, or contribute code, your efforts are appreciated. This guide outlines the process for contributing to wecli.

Table of Contents

Code of Conduct

Before getting started, please read and adhere to our Code of Conduct. We aim to create a welcoming and inclusive environment for everyone.

How Can I Contribute?

There are various ways you can contribute to flow:

  • Reporting bugs
  • Suggesting enhancements
  • Writing code improvements
  • Improving documentation

Choose the contribution method that best fits your skills and interests.

Reporting Bugs

If you encounter a bug or unexpected behavior, please open an issue and provide details about the problem. Include steps to reproduce the issue and any relevant information about your environment.

Suggesting Enhancements

If you have ideas for new features or improvements, open an issue and describe the enhancement you're proposing. Discussion on proposed enhancements is welcome before any code is written.

Setting Up Your Development Environment

To contribute code to flow, you'll need to set up your development environment:

  1. Fork the fork repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Install Go if you haven't already: https://golang.org/dl/.
  4. Run go install in the project directory to build and install flow.

Making Changes

Before making changes, create a new branch for your work:

git checkout -b my-feature-branch

Make your changes, commit them with clear messages, and push the branch to your fork on GitHub:

git push origin my-feature-branch

Submitting a Pull Request

When you're ready to submit your changes, open a pull request:

  1. Navigate to the flow pull request page.
  2. Click the "New pull request" button.
  3. Select your branch as the compare branch.
  4. Follow the pull request template and provide information about your changes.

Code Review Process

Your pull request will be reviewed by maintainers and contributors. Expect feedback and be prepared to address any suggested changes. Once approved, your changes will be merged into the main branch.

Conclusion

Thank you for considering contributing to flow! Your contributions help improve the tool for everyone. If you have any questions, feel free to reach out to me through Twitter. Happy coding!