diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a276f0a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Welcome to hydra-lock-gui contributing guide + +Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [hydra-flock-gui repo](https://github.com/HTTP-APIs/hydra-flock-gui) ✨. + +Read our [Code of Conduct]() to keep our community approachable and respectable. + +In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR. + +To get an overview of the project, read the [README](https://github.com/HTTP-APIs/hydra-flock-gui/blob/master/README.md). Here are some resources to help you get started with open source contributions: + +- [Finding ways to contribute to open source on hydra](https://github.com/HTTP-APIs) +- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git) +- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests) + +## [](https://github.com/github/docs/blob/main/CONTRIBUTING.md#getting-started)Getting started + +To navigate our codebase with confidence, see [the introduction to working in the docs repository](https://github.com/github/docs/blob/main/contributing/working-in-docs-repository.md) 🎊. For more information on how we write our markdown files, see [the GitHub Markdown reference](https://github.com/github/docs/blob/main/contributing/content-markup-reference.md). + +Check to see what [types of contributions](https://github.com/github/docs/blob/main/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code ✨. + +### [](https://github.com/github/docs/blob/main/CONTRIBUTING.md#issues)Issues + +#### [](https://github.com/github/docs/blob/main/CONTRIBUTING.md#create-a-new-issue)Create a new issue + +If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose). + +#### [](https://github.com/HTTP-APIs/hydra-flock-gui/issues)Solve an issue + +Scan through our [existing issues](https://github.com/HTTP-APIs/hydra-flock-gui/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. + +#### Make changes locally + +1. Fork the repository. + +2. Install repository + +3. Create a working branch and start with your changes! + + +### Commit your update + +Commit the changes once you are happy with them. +Once your changes are ready, don't forget to self review. + +### Pull Request + +When you're finished with the changes, create a pull request, also known as a PR. + +- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. +- Don't forget to link PR to issue if you are solving one. +- Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request for additional information. +- We may ask for changes to be made before a PR can be merged, either using pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch. +- If you run into any merge issues, checkout this [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) to help you resolve merge conflicts and other issues. + +### Your PR is merged! + +Congratulations πŸŽ‰πŸŽ‰ The hydra team thanks you ✨. + +Once your PR is merged, your contributions will be publicly visible on the [hydra-flock-gui](https://github.com/HTTP-APIs/hydra-flock-gui).