Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/callaunchpad/MeTaL
Browse files Browse the repository at this point in the history
  • Loading branch information
azahed98 committed Sep 16, 2018
2 parents 70ae74a + ef3c145 commit d2fee3e
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ This should add any required dependencies to your virtual environment.
## Contributing Code and Workflow
**Please make sure all commits have meaningful comments!**

Do not use `git add .` to add files. This adds files that should potentially be untracked. Instead, use
```
git commit -am "commit message"
```
This adds and commits all modified files that are tracked. If you need to track new files, then use
```
git add new_file_name_here
```

When contributing code, make sure you code is documented. Each file should have a header explaining the contents within a few sentences, as well as the names of all contributing authors. Each class, function and method should be documented with the following style:

```
Expand Down

0 comments on commit d2fee3e

Please sign in to comment.