gls is a MIT licensed minimal file manager project written in Go, and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, pull request message formatting, and other resources to make it easier to get your contribution accepted.
- Fork the project github.com/ozansz/gls to your own account
- Clone the repository on your development machine
git clone git@github.com:<your-username>/gls.git- Make sure the CLI builds flawlessly
cd gls
go build cmd/gls/main.goThis is a outline of what a contributor's workflow looks like:
-
Select an issue to work on from github.com/ozansz/gls/issues, OR open an issue on the same page if you found another issue to fix, or have an idea to improve the project
-
Create a separate branch from
masterbranch to base your work.
git checkout -b this-is-a-super-cool-feature-
Work on your fix/implementation. Also please do proper commenting on your code where it may be hard for people to understand at first sight
-
Update the documentation (currently only the README.md) if needed
-
Push your changes to the branch you have created
-
Submit a pull request to the original repository. Please see the section below section before opening your PR
Please follow the below format while creating your pull request:
- Title: Make sure that your PR's title summarizes your contribution in a short simple sentence. Ex: "update installation section of documentation"
Note: Your PR title doesn't have to be the same as the title of the issue you're intended to fix, if you're fixing a specific issue in the PR.
- Content: We have a PR template which includes some related information about your implementation and fixes which make it easier for us to review your contribution. Please make sure to follow the template.
Please check the code of conduct before contribution.