Skip to content

Latest commit

 

History

History
48 lines (27 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

48 lines (27 loc) · 2.63 KB
Raw

🤝 Contributing

Awesome, you're interested in contributing to the flow-merge-ui project! We're stoked to have you on board and can't wait to see what amazing things you'll bring to the table.

We want contributing to be easy and effortless so by following these guidelines we ensure smooth collaboration with managing the project, addressing issues, assessing changes and finalizing the pull requests.

There are many ways to contribute to project. For example:

  • submitting bug reports
  • fixing bugs
  • issuing feature requests
  • building new features
  • improving docs
  • writing tutorials, blogposts etc

How to contribute?

🐞 Bug reports

If you find a bug in the project please open an issue on the project's GitHub repository. Be sure to include a clear description of the issue, steps to reproduce it, and any relevant error messages or logs.

📝 Feature requests

If you have an idea for a new feature or enhancement, please open a new feature request on the project's GitHub repository. Describe the feature you'd like to see and why you think it would be valuable.

💻 Pull requests

Before starting with any significant work on a new feature please submit a new feature request to discuss the idea. This way we can ensure that your time and efforts are wisely spend and your pull request gets approved.

How to create the pull request?

Here's a simple list of steps on how to create a pull request to an open source project on GitHub:

  1. Fork the repository: Visit the repository on GitHub and click the "Fork" button in the top-right corner. This creates a copy of the repository in your GitHub account.

  2. Clone the forked repository: On your local machine, clone the forked repository using the command git clone https://github.com/your-username/repository-name.git.

  3. Create a new branch: Navigate to the cloned repository and create a new branch for your changes using the command git checkout -b new-branch-name.

  4. Make your changes: Open the files in your preferred code editor and make the desired changes. Once happy with the result you can commit and push your changes.

  5. Create a pull request: Visit the original repository on GitHub, and you should see a prompt to create a pull request. Click on the prompt or navigate to the "Pull requests" tab and click "New pull request".

  6. Wait for review: The project maintainers will review your pull request and may provide feedback or merge your changes into the main repository.

🫶 Community

For now please add any questions and comments on the discussions on Github. In the future we plan to introduce more community channels and resources!