Hi! Thanks for your interest in helping to make this project more awesome by contributing.
Contribution can be anything like (but not limited to) improving documentation, reporting bugs, feature requests, contributing code.
- First make sure that the bug has not already been reported.
- Create a bug report.
- It would be helpful for us if the issue:
- can be descriptive.
- have information like Operating system, ghs version, etc.
- have steps to reproduce the error.
- have error stacktrace.
- First make sure that the feature has not already been requested.
- Create a feature request.
- Pick up an issue (or create one) on which you want to work. You can take help of labels to filter them down.
- Tell beforehand that you are working on the issue. This helps in making sure that multiple contributors are not working on the same issue.
- Fork the repository and clone it locally.
- Please create a separate branch for each issue that you're working on. Do not make changes to the default branch (e.g. master) of your fork.
- Make changes to the code and
- Install the cli via source code and check/confirm your changes.
- Commit the changes to the issue branch you created. Please Write descriptive commits.
- Push the changes to your fork and submit a Pull Request with the issue reference.
This project uses the Black code formatter for formatting the code. Flake8 is used for linting the code and validating the style and structure.