Merge pull request #62 from theodo/add-changelog-and-contributing-docs

Add CHANGELOG and CONTRIBUTING docs

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2019-10-25
+
+### Fixed
+
+- Fixed a SSL problem in Docker Compose deployment (@kraynel)
+
+### Added
+
+- Improve build time (@kraynel)
+- Added this very Changelog (@phacks)
+- Added a Contributing guide (@phacks)
+
+## [1.0.0] - 2019-10-24
+
+🎉Initial release! 🎉
+
+[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/olivierlacan/keep-a-changelog/releases/tag/1.0.0

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to Falco
+
+You are here to help on Falco? Awesome, feel welcome and read the following sections in order to know how to ask questions and how to work on something.
+
+All members of our community are expected to follow our [Code of Conduct](./CODE_OF_CONDUCT.md). Please make sure you are welcoming and friendly in all of our spaces.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
+
+There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into Falco itself.
+
+## Improving the docs
+
+The Falco docs are stored in the `docs/` folder in this very repository. The actual documentation is written in [GitHub Flavoured Markdown](https://github.github.com/gfm/) in individual files in the `docs/docs/` subfolder. You can edit individual files right inside the GitHub editor, which does not require any local setup.
+
+To edit a piece of documentation, you can click on the “Edit this page” link in the docs you would like to update:
+
+![Edit this doc button](/docs/static/img/edit-docs.png)
+
+## Local development on Falco
+
+This section will guide you through installing Falco on your development machine, so that you can work on your feature or bug fix locally before submitting a PR.
+
+### First installation
+
+- Clone the repository:
+ ```bash
+ git clone [email protected]:theodo/falco.git
+ ```
+- Move to the `falco` directory:
+ ```bash
+ cd falco
+ ```
+- Install the backend and the frontend:
+ ```bash
+ make install
+ ```
+- Start the backend:
+ ```bash
+ make backend/start
+ ```
+- Populate the database with fixtures:
+ ```bash
+ make fixtures/load
+ ```
+- Edit the .env file: replace the initial SECRET_KEY with a random string
+
+### To (re)start the app
+
+- Start the backend:
+ ```bash
+ make backend/start
+ ```
+- Start the frontend:
+
+ ```bash
+ make frontend/start
+ ```
+
+The project should now be running at [localhost:3000](http://localhost:3000). You can access to the Django administration interface at [http://localhost:8000/admin/](http://localhost:8000/admin/).
+
+To access both these interfaces, you can login using the following credentials:
+
+- username: `admin`
+- password: `admin`

README.md

@@ -42,50 +42,9 @@ You will need to provide your credit card details to Heroku, but you will be und
 
 Full documentation for Falco lives on the [docs website](https://getfal.co).
 
-## Local development
-
-### First installation
-
-- Clone the repository:
- ```bash
- git clone [email protected]:theodo/falco.git
- ```
-- Move to the `falco` directory:
- ```bash
- cd falco
- ```
-- Install the backend and the frontend:
- ```bash
- make install
- ```
-- Start the backend:
- ```bash
- make backend/start
- ```
-- Populate the database with fixtures:
- ```bash
- make fixtures/load
- ```
-- Edit the .env file: replace the initial SECRET_KEY with a random string
-
-### To (re)start the app
-
-- Start the backend:
- ```bash
- make backend/start
- ```
-- Start the frontend:
-
- ```bash
- make frontend/start
- ```
-
-The project should now be running at [localhost:3000](http://localhost:3000). You can access to the Django administration interface at [http://localhost:8000/admin/](http://localhost:8000/admin/).
-
-To access both these interfaces, you can login using the following credentials:
-
-- username: `admin`
-- password: `admin`
+## Contributing
+
+Thanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](./CONTRIBUTING.md).
 
 ## Contributors ✨