github.com/shravanasati/hydra@v1.0.1-0.20240122045627-1082d2ed50d2/CONTRIBUTING.md (about) 1 # Contributing to hydra 2 3 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 4 5 The following is a set of guidelines for contributing to *hydra*, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. 6 7 8 ## Project Structure 9 ``` 10 ├── .github 11 | ├── ISSUE_TEMPLATE # issue templates 12 | | ├── bug_report.md 13 | | ├── custom.md 14 | | └── feature_request.md 15 | └── workflows # ci workflow 16 | └── go.yml 17 ├── .gitignore 18 ├── CHANGELOG.md 19 ├── CONTRIBUTING.md 20 ├── LICENSE 21 ├── README.md 22 ├── assets # media assets for readme 23 | ├── python_dir.PNG 24 | └── python_init.PNG 25 ├── config.go # config command code 26 ├── gitignores # all gitignores 27 | ├── go.gitignore 28 | └── python.gitignore 29 | └── ruby.gitignore 30 | └── c.gitignore 31 | └── c++.gitignore 32 ├── go.mod 33 ├── go.sum 34 ├── hydra.go # main code for the cli 35 ├── hydra_test.go # unittests for hydra 36 ├── init.go # init command code 37 ├── list.go # list command code 38 └── licenses # all licenses 39 ├── APACHE 40 ├── BSD 41 ├── EPL 42 ├── GPL 43 ├── MIT 44 └── MPL 45 └── UNI 46 ``` 47 48 ## Setup Development Environment 49 This section shows how you can setup your development environment to contribute to hydra. 50 51 - Fork the repository. 52 - Clone it using Git (`git clone https://github.com/<YOUR USERNAME>hydra.git`). 53 - Create a new git branch (`git checkout -b "BRANCH NAME"`). 54 - Install the `commando` module using the command `go get github.com/thatisuday/commando`. 55 - Make changes. 56 - Stage and commit (`git add .` and `git commit -m "COMMIT MESSAGE"`). 57 - Push it your remote repository (`git push`). 58 - Open a pull request by clicking [here](https://github.com/shravanasati/hydra/compare). 59 60 61 ## Reporting Issues 62 If you know a bug in the code or you want to file a feature request, open an issue. 63 Choose the correct issue template from [here](https://github.com/shravanasati/hydra/issues/new/choose).