Development Guidelines

Here we'll try to keep a list of development standards to be used in this project. This will be increasingly important for materials visible to students, but also for general organizational purposes.

Contributing

The brainstorm repo is exactly what it sounds like: a place to test out our ideas and see what works. Here, I think we shouldn't worry too much about pull requests, code review, etc. and just let each member push freely to the repo.

However, when it comes time to begin committing to rescu_textbook, I think we should be a bit more careful. Before pushing material to the main text, we should make sure that everyone has the opportunity to review said material. Pull requests are a great way to do this. That way, everyone gets to see the change set before it gets merged. So a sample workflow might look like this:

1. Fork rescu/rescu_textbook to user_foo_bar/rescu_textbook
2. Clone user_foo_bar/rescu_textbook
3. Add an upstream to rescu/rescu_textbook in your local repo
4. Got a new feature/chapter/section/whatever to add? Create a new branch!
5. Do some work on the branch
6. Create a pull request
7. People comment
8. You fix stuff
9. More comments
10. Repeat ad nauseum
11. Once there is a consensus, your code gets merged!

Branching

How much do we want to utilize branches? dev? master? releases? versions?

Style

Plots, coding, equations, etc.

Coding Standards

For our sake and to alleviate confusion on the part of the students.

Testing

Not sure how necessary this will be. May become more apparent as amount of material grows.