Merge branch 'development' into task-bre-params

Author: tmilar

.gitattributes

@@ -1,2 +1,3 @@
+*.sol linguist-language=Solidity
 # prevent github actions to checkout files with crlf line endings
 * -text

.github/workflows/CI.yml

@@ -1,6 +1,13 @@
 name: CI
 
-on: [pull_request, push]
+on:
+  push:
+    branches:
+      - master
+      - development
+  pull_request:
+    branches:
+      - "*"
 
 jobs:
   lint:

.gitignore

@@ -8,8 +8,8 @@ package-lock.json
 
 .DS_Store
 
-# Below is Github's node gitignore template, except for dotenv's entries as it's used by mocha to pass flags to ts-node,
-# and ignoring the node_modules part, as it'd ignore every node_modules, and we have some for testing
+# Below is Github's node gitignore template,
+# ignoring the node_modules part, as it'd ignore every node_modules, and we have some for testing
 
 # Logs
 logs
@@ -71,10 +71,6 @@ typings/
 # Yarn Integrity file
 .yarn-integrity
 
-# dotenv environment variables file
-#.env
-#.env.test
-
 # parcel-bundler cache (https://parceljs.org/)
 .cache
 

CONTRIBUTING.md

@@ -33,7 +33,9 @@ docker pull ethereum/vyper:0.1.0b10
 ```
 
 ### Entire project
-You can run all the tests at once by running `npm test` from the root folder. Requires `ethereum/vyper` docker instance installed for package [buidler-vyper](./packages/buidler-vyper), see previous section for details.
+You can run all the tests at once by running `npm test` from the root folder.
+
+For the case of package [buidler-vyper](./packages/buidler-vyper), an `ethereum/vyper` docker instance installed is required (see previous section for details). _Exception_ of this requirement is if running on a Windows local machine, in this case we skip it by default since Win 10 Pro version would be also required.
 
 ## Code formatting
 
@@ -46,6 +48,15 @@ Prettier and forbids some dangerous patterns.
 The linter is always run in the CI, so make sure it passes before pushing code. You can use `npm run lint` and
 `npm run lint:fix` inside the packages' folders.
 
+## Branching
+
+We work on the branch [`development`](https://github.com/nomiclabs/buidler/tree/development)
+and keep `master` in sync with the latest release.
+
+Please, branch from `development` when implementing a new feature or fixing a 
+bug, and use it as the base branch in every pull request.
+
+
 ## Dependencies
 
 We keep our dependencies versions in sync between the different projects.