diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e88c929..c7cb0c9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,14 +6,20 @@ This page provides information about contributing code to this list of Evergreen ### Get your copy -* Fork the repository on Github -* Clone the forked repository to your machine -* Set up the official repository as a new "remote" in your cloned repository -so that you can fetch new changes from it +* Fork the repository on GitHub. +* Clone the forked repository to your machine. +* Set up the official repository as a new "remote" in your cloned repository so that you can fetch new changes from it. + +For more information, please refer to [GitHub's instructions on this](https://help.github.com/articles/fork-a-repo/). ## Propose Changes -To submit changes, use a [GitHub Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from your fork to this repository. +To submit changes: + * Make sure your local copy is updated. + * Create a dedicated branch locally (`git checkout-b `). + * Add your changes by creating [_micro commits_](https://lucasr.org/2011/01/29/micro-commits/). + * Once your changes are completed, push them to your fork. + * Finally, create a [GitHub Pull Request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) from your fork, by using GitHub's web interface. When your Pull Request is ready to be merged, the repository maintainers will integrate it and it will be published in the next release. diff --git a/README.md b/README.md index 631bfb9..4108f30 100644 --- a/README.md +++ b/README.md @@ -80,9 +80,11 @@ _This is a work in progress. Important knowledge might be missing, existing bull ### General Technical Knowledge #### Principles + * Basics: General control structures and boolean algebra * OOP * SOLID, GRASP * Functional programming (pure function, recursion,...) + * Declarative vs Imperative programming ([see differences](http://amzotti.github.io/programming%20paradigms/2015/02/13/what-is-the-difference-between-procedural-function-imperative-and-declarative-programming-paradigms/)] #### Data Structures * Basic structures (basic types, array, matrix, object...) diff --git a/changelog.md b/changelog.md index f1e8ca1..c511b87 100644 --- a/changelog.md +++ b/changelog.md @@ -18,22 +18,27 @@ This file keeps a log of version releases. This file is maintained ## Release Change History -### [Unreleased] [2.0.0] (New sections X, Y, Z and major changes in existing sections) +### [2.0.0] (New sections X, Y, Z and major changes in existing sections) #### Added * Architecture and Infrastructure section * Security section +* "Semantic versioning", included in the "Clean Code" section +* "Dependency management", in the "Collaboration and SCM" section +* "Control structures and boolean algebra", into "Principles" +* "Imperative vs declarative programming", included in the principles section, with a reference article #### Changed * Back-end section: minor changes to existing items and added some new concepts (e.g. "session handling" and "database design") * Splitted "Principles" section, creating also "Data Structures" -* Added links to e-mail and chat (Slack) communication best practices +* Included a link to e-mail and chat (Slack) communication best practices +* Linked to article about the productivity cost of interruptions #### Removed -* +* . ### [1.0.0] (First release)