Skip to content

Commit

Permalink
Push up a portion for formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
tonychen091 committed Jul 13, 2017
1 parent ab1c759 commit 793763f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ To be added.

## VII. Contribution Information

Please read our [contributing guide/](docs/contributing_guide.md) to learn about our development process, how to propose pull requests and improvements, and how to build and test your changes to this project.
Please read our [contributing guide](docs/contributing_guide.md) to learn about our development process, how to propose pull requests and improvements, and how to build and test your changes to this project.


[Back to top](#toc)
37 changes: 37 additions & 0 deletions docs/contributing_guide.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,41 @@
# Contributing Guide

## Open source license

By contributing to the US Department of Transportation Joint Program office (JPO) Operational Data Environment (ODE), you agree that your contributions will be licensed under its Apache License 2.0 license.

## Style Guide

[Code Standards](https://usdotjpoode.atlassian.net/wiki/display/USDOTJPODE/Code+Standards)
[Effective Java Second Edition] (https://www.ebooksbucket.com/uploads/itprogramming/java/Effective_Java_2nd_Edition.pdf)

## Miscellaneous Documentation

[JPO-ODE GitHub page](https://github.com/usdot-jpo-ode/jpo-ode)
[Confluence Wiki](https://usdotjpoode.atlassian.net/wiki/)
[ODE Architecture](https://github.com/usdot-jpo-ode/jpo-ode/blob/develop/docs/JPO%20ODE%20Architecture.docx)
[ODE User Guide](https://github.com/usdot-jpo-ode/jpo-ode/blob/develop/docs/JPO_ODE_UserGuide.docx)
[ODE REST API Guide](usdot-jpo-ode.github.io)
[ODE Smoke Tests](https://github.com/usdot-jpo-ode/jpo-ode/wiki/JPO-ODE-QA-Documents)

## Tools

### Issue tracker
Contributors will utilize Github's issue tracking system to record and manage issues that are reported by users of the ODE in the field. These may include performance requests, found bugs, and new requests. The follow operating procedure highlights how the ODE development team will address and respond to reported issues.

Issue Repository: [https://github.com/usdot-jpo-ode/jpo-ode/issues](https://github.com/usdot-jpo-ode/jpo-ode/issues)

### Pull requests

[Jpo-Ode GitHub Pull Request Page](https://github.com/usdot-jpo-ode/jpo-ode/pulls)

All pull requests will be reviewed by the JPO-ODE team. During the review of your pull request the team member will either merge it, request changes to it, or close it with an explanation. For major changes the reviewer may require additional support from the team, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.
*Before submitting a pull request*, please make sure the following is done:
1. Fork the repository and create your branch from the master.
2. If you've added code that should be tested, add tests!
3. Ensure the tests pass.
4. Update the documentation.
5. Format your code as outlined in the style guide



0 comments on commit 793763f

Please sign in to comment.