-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
104 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
![ESPIn logo](../../media/ESPIn.png) | ||
|
||
# Using GitHub in a collaborative project ("Gitiquette") | ||
|
||
This may just be a bullted list. | ||
|
||
Show a demo of making issue and proper PR. | ||
|
||
|
||
## Summary | ||
|
||
Concepts table. | ||
|
||
This may just be a list? | ||
|
||
|
||
## Resources | ||
|
||
* | ||
|
||
|
||
___ | ||
|
||
[Best Practices in Software Development](./index.md) | | ||
Previous: [Continuoues integration with Travis CI](./continuous-integration.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
![ESPIn logo](../../media/ESPIn.png) | ||
|
||
# Continuous integration with Travis CI | ||
|
||
Define *continuous integration*. | ||
|
||
This may just be a bullted list. | ||
|
||
Show how the ESPIn repo is under CI. | ||
Travis config file (`.travis.yml`). | ||
Not a realtime demo. | ||
|
||
|
||
## Summary | ||
|
||
Concepts table. | ||
|
||
|
||
## Resources | ||
|
||
* Travis CI docs | ||
|
||
|
||
___ | ||
|
||
[Best Practices in Software Development](./index.md) | | ||
Previous: [Unit testing with pytest](./unit-testing.md) | ||
Next: [Using GitHub in a collaborative project ("Gitiquette")](./collaboration-etiquette.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,31 @@ | ||
![ESPIn logo](../../media/ESPIn.png) | ||
|
||
# Best Practice in Software Development | ||
# Best Practices in Software Development | ||
|
||
In this lesson, we'll discuss three topics that will improve your productivity | ||
as an ESP scientist: | ||
|
||
* unit testing | ||
* continous integration | ||
* collaboration techniques on GitHub | ||
|
||
*( Maybe say what is meant by "best practices" )* | ||
|
||
|
||
|
||
*Learning objectives:* | ||
|
||
* Understand unit testing concepts | ||
* Understand continuous integration concepts | ||
* See how to write a unit test for `pytest` | ||
* Understand some recommended behavior for collaborative projects on GitHub | ||
|
||
|
||
## Topics | ||
|
||
This lesson continues in the following sections. | ||
|
||
1. [Unit testing with pytest](./unit-testing.md) | ||
1. [Continuoues integration with Travis CI](./continuous-integration.md) | ||
1. [Using GitHub in a collaborative project ("Gitiquette")](./collaboration-etiquette.md) | ||
|
||
Coming soon (before Tuesday 9:30 am MT)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
![ESPIn logo](../../media/ESPIn.png) | ||
|
||
# Unit testing with pytest | ||
|
||
Pull material from the webinar. | ||
|
||
|
||
## Summary | ||
|
||
Concepts table. | ||
Or maybe just a bulleted list. | ||
|
||
|
||
## Resources | ||
|
||
* Software Carpentry Incubator [lesson](http://carpentries-incubator.github.io/python-testing/) on unit testing and continous integration (in development) | ||
|
||
|
||
___ | ||
|
||
[Best Practices in Software Development](./index.md) | | ||
Previous: [index](./index.md) | | ||
Next: [Continuoues integration with Travis CI](./continuous-integration.md) |