- add CONTRIBUTING.MD

- resolve #76

.github/ISSUE_TEMPLATE/feature_request.md → .github/ISSUE_TEMPLATE/feature-request.md

@@ -15,3 +15,7 @@ A clear and concise description of any alternative solutions or features you've
 
 **Additional context**
 Add any other context or screenshots about the feature request here.
+
+
+<!-- DO NOT EDIT BELOW THIS LINE -->
+/kind feature

CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contribution Guidelines
+Please read this guide if you plan to contribute to the DevSpace CLI. We welcome any kind of contribution. No matter if you are an experienced programmer or just starting, we are looking forward to your contribution.
+
+## Reporting Issues
+If you find a bug while working with the DevSpace CLI, please [open an issue on GitHub](https://github.com/covexo/devspace/issues/new?labels=kind%2Fbug&template=bug-report.md&title=Bug:) and let us know what went wrong. We will try to fix it as quickly as we can.
+
+## Feature Requests
+You are more than welcome to open issues in this project to [suggest new features](https://github.com/covexo/devspace/issues/new?labels=kind%2Ffeature&template=feature-request.md&title=Feature%20Request:).
+
+## Contributing Code
+This project is mainly written in Golang. To contribute code,
+1. Fork the project
+2. Clone the project: `git clone https://github.com/[YOUR_USERNAME]/devspace && cd devspace`
+3. Install the dependencies: `dep ensure -v` (requires [Installing Dep](https://golang.github.io/dep/docs/installation.html))
+4. Make changes to the code (add new dependencies to the Gopkg.toml)
+5. Build the project, e.g. via `go build -o devspace.exe`
+6. Make changes
+7. Run tests: `go test ./...`
+8. Format your code: `go fmt ./...`
+9. Commit changes
+10. Push commits
+11. Open pull request
+
+## Improving the Documentation
+The documentation is contained within `./docs` and made with Docusaurus. See the [Docs README](./docs) for infos about developing the docs.

README.md

@@ -1,9 +1,9 @@
 ![DevSpace Workflow](docs/website/static/img/header-readme.svg)
 
-# DevSpace - Cloud-Native Development with Kubernetes
+# DevSpace - Cloud Native Development with Kubernetes
 [![Build Status](https://travis-ci.org/covexo/devspace.svg?branch=master)](https://travis-ci.org/covexo/devspace)
 [![Go Report Card](https://goreportcard.com/badge/github.com/covexo/devspace)](https://goreportcard.com/report/github.com/covexo/devspace)
-[![Join the community on Spectrum Chart](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/devspace)
+[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/home?status=Just%20found%20out%20about%20DevSpace%20CLI%20-%20It%20lets%20you%20build%20cloud%20native%20software%20directly%20on%20top%20of%20Kubernetes&url=https://www.github.com.com/covexo/devspace&via=covexo&hashtags=kubernetes,k8s,devspace,docker,cloudnative)
 
 With a DevSpace, you can build, test and run **code directly inside any Kubernetes cluster**. You can run `devspace up` in any of your projects and the client-only DevSpace CLI will start a DevSpace within your Kubernetes cluster. Keep coding as usual and the DevSpace CLI will sync any code change directly into the containers of your DevSpace. 
 
@@ -34,7 +34,7 @@ Take a look at the [Getting Started Guide](https://devspace-cloud.com/getting-st
 **Note:** Don't worry, you can use `devspace reset` to reset your project and go back to local development.
 
 ## [Installation](https://devspace.covexo.com/docs/getting-started/installation.html)
-These commands will install the DevSpace CLI and add it to the PATH environment variable. For more details, see: [Install Guide](https://devspace.covexo.com/docs/getting-started/installation.html)
+These commands will install the DevSpace CLI and add it to the PATH environment variable. For more details, see: [Getting Started](https://devspace-cloud.com/getting-started/)
 
 ### For Windows
 1. Open Powershell with **admin rights**.
@@ -66,11 +66,6 @@ Here you can find some links to the most important pages of our documentation:
 - [CLI Documentation](https://devspace.covexo.com/docs/cli/init.html)
 - [Architecture Documentation](https://devspace.covexo.com/docs/advanced/architecture.html)
 
-## [DevSpace Cloud](https://devspace-cloud.com/)
-The DevSpace Cloud provides hosted DevSpaces. The service is currently in private beta. If you would like to join the beta program, you can **[request access to the DevSpace Cloud](https://devspace-cloud.com/)**. 
-
-As a thank you for testing the DevSpace Cloud, members of the beta program will receive a special **forever free subcription** to the DevSpace Cloud.
-
 ## [Architecture](https://devspace.covexo.com/docs/advanced/architecture.html)
 Architecturally, the DevSpace CLI is a client-side software that interacts with services within your Kubernetes cluster. While the DevSpace CLI can deploy required services (e.g. image registry, Tiller server, Kaniko build pods) automatically, you can also configure it to use already deployed or externally hosted services.
 
@@ -84,12 +79,12 @@ For a more detailed description of the internals of the DevSpace CLI, take a loo
 As any open source projects, we are looking forward to your contributions.
 
 ### Reporting Issues
-If you find a bug while working with the DevSpace CLI, please [open an issue on GitHub](https://github.com/covexo/devspace/issues/new?labels=kind%2Fbug&title=Bug:) and let us know what went wrong. We will try to fix it as quickly as we can.
+If you find a bug while working with the DevSpace CLI, please [open an issue on GitHub](https://github.com/covexo/devspace/issues/new?labels=kind%2Fbug&template=bug-report.md&title=Bug:) and let us know what went wrong. We will try to fix it as quickly as we can.
 
 ### Feedback & Feature Requests
 You are more than welcome to open issues in this project to:
 - [give feedback](https://github.com/covexo/devspace/issues/new?labels=kind%2Ffeedback&title=Feedback:)
-- [suggest new features](https://github.com/covexo/devspace/issues/new?labels=kind%2Ffeature&title=Feature%20Request:)
+- [suggest new features](https://github.com/covexo/devspace/issues/new?labels=kind%2Ffeature&template=feature-request.md&title=Feature%20Request:)
 - [ask a question](https://github.com/covexo/devspace/issues/new?labels=kind%2Fquestion&title=Question:)
 
 ### Contributing Code

docs/README.md

@@ -0,0 +1,19 @@
+# DevSpace CLI Documentation
+This documentation is created with Docusaurus.
+
+## Contributing
+To contribute code,
+1. Fork the project
+2. Clone the DevSpace CLI project: `git clone https://github.com/[YOUR_USERNAME]/devspace && cd devspace/docs/website`
+3. Start a DevSpace for the docs page: `devspace up`
+4. Wait for the DevSpace terminal to open and run: `npm run start`
+5. Make changes
+6. Test your changes on: [http://localhost:3000/](http://localhost:3000/)
+7. Commit changes
+8. Push commits
+9. Open pull request
+
+Docusaurus allows you to use hot reloading when editing the docs pages, so you can now edit any docs page in ./docs and Docusaurus will recompile the markdown and reload the website automatically.
+
+## [Contribution Guidelines](../CONTRIBUTING.md)
+For general information regarding contributions see: [Contribution Guidelines](../CONTRIBUTING.md)