Skip to content

Commit

Permalink
Merge pull request #4 from romenrg/improve-principles-and-contributing
Browse files Browse the repository at this point in the history
Improve principles and contributing
  • Loading branch information
romenrg authored Jan 19, 2019
2 parents 7c8ef9b + 4b56e39 commit acae9f4
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 8 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <nombre-de-la-rama>`).
* 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.

Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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...)
Expand Down
11 changes: 8 additions & 3 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit acae9f4

Please sign in to comment.