create missing community-related resources (#11)

.github/pull_request_template.md

@@ -0,0 +1,25 @@
+## Summary
+
+> Please list the summary of your changes in the codebase about the related issue here. Please also include the context of your changes, and required next steps if there are any.
+
+Fixes # (issue)
+
+### Impact
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (backward compatible changes which fix an issue)
+- [ ] New feature (backward compatible change which adds functionality)
+- [ ] Major update (fix or feature that would cause existing functionality to not work as expected)
+
+### Testing
+
+> Please describe the tests that you ran to verify your changes. Provide step-by-step instructions so anyone can also test your implementation.
+
+**Test Configuration**:
+* Go version: 
+* Hardware:
+* Operating system:
+
+1. 
+2. 

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+ozan.sazak@protonmail.ch.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+[gls](https://github.com/ozansz/gls) is a [MIT](LICENSE) 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.
+
+## Table of Contents
+* [Getting Started](#getting-started)
+* [Contribution Flow](#contribution-flow)
+    + [Opening a pull request](#opening-a-pull-request)
+* [Code of Conduct](#code-of-conduct)
+
+## Getting Started
+
+1. Fork the project [github.com/ozansz/gls](https://github.com/ozansz/gls) to your own account
+2. Clone the repository on your development machine
+
+```bash
+git clone git@github.com:<your-username>/gls.git
+```
+
+3. Make sure the CLI builds flawlessly
+
+```bash
+cd gls
+go build cmd/gls.go
+```
+
+## Contribution Flow
+
+This is a outline of what a contributor's workflow looks like:
+
+1. Select an issue to work on from [github.com/ozansz/gls/issues](https://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
+
+2. Create a separate branch from `master` branch to base your work.
+
+```bash
+git checkout -b this-is-a-super-cool-feature
+```
+
+3. 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
+
+4. Update the documentation (currently only the [README.md](README.md)) if needed
+
+4. Push your changes to the branch you have created
+
+5. Submit a pull request to the original repository. Please see [the section below](#opening-a-pull-request) section before opening your PR
+
+### Opening a pull request
+
+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.
+
+## Code of Conduct
+
+Please check the [code of conduct](CODE_OF_CONDUCT.md) before contribution.

README.md

@@ -7,6 +7,18 @@
 
 It’s `ls` + `du` + `tree` with interactive TUI on your terminal! `gls` is created to easily view, filter and search your files, folders and directories with their size whenever you need to open up some storage space. It wouldn’t be wrong to say that `gls` is a minimal yet powerful file manager CLI tool.
 
+## Table of Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+	+ [Default usage (TUI)](#default-usage-tui)
+	+ [Text mode](#text-mode)
+* [Features](#features)
+	+ [TUI shortcuts](#tui-shortcuts)
+	+ [Configuration](#configuration)
+	+ [Command line arguments](#command-line-arguments)
+* [How to Contribute](#how-to-contribute)
+
 ##  Installation
 Installing `gls` on your machine is pretty simple: just clone the repo and install `cmd/gls.go`:
 
@@ -111,4 +123,12 @@ In addition, if you think that your configurations or other changes seem necessa
 -thresh string
     	size filter threshold, e.g. 10M, 100K, etc.
 ```
-> You can also read this section from terminal by using `gls` without parameters.
+> You can also read this section from terminal by using `gls` without parameters.
+
+## How to Contribute
+
+You are very welcome to contribute to `gls`! Here are a few steps to guide you how to start contributing:
+
+1. Check [the open issues tab](https://github.com/ozansz/gls/issues) to see if there are any issue you may be interested in fixing. You can also list the [issues with only the good-first-issue tag](https://github.com/ozansz/gls/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+
+2. Check the [contributing guide](CONTRIBUTING.md) for more explanation on setting up the development environment, opening the PR, etc.