Skip to content

Commit

Permalink
Add initial CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
YongJieYongJie committed Mar 9, 2016
1 parent 22613e9 commit cc5bfef
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to TEAMMATES

Contributions are very welcomed.
But do ensure that you have conformed to the following:
- Best practices for: [UI design][ui], [Coding][code], [Testing][test]
- Coding standards for: [Java][java], [JSP][jsp], [JavaScript][js], [CSS][css], [HTML][html]
- [TEAMMATES Development Process][dev] (including naming conventions for commits and pull request, etc.)

[ui]: https://docs.google.com/document/d/1Vj59--sCYUfxgg-iLI53hMfc6YY1gguATTN_KXTQVUo/pub?embedded=true
[code]: https://docs.google.com/document/d/14EFJzdhp10qQ9iZ-FwsS1FAf42voe4exrlbefo_zYaU/pub?embedded=true
[test]: https://docs.google.com/document/d/1aK-1ubIA59fbNsEujwvWKqx7itwLPTD6mzFo4F_oEoI/pub?embedded=true

[java]: https://docs.google.com/document/pub?id=1iAESIXM0zSxEa5OY7dFURam_SgLiSMhPQtU0drQagrs&embedded=true
[jsp]:https://docs.google.com/document/d/14bXfdveXvoIaPBYpL19m4PK6oPabSnnoawj6OGjOzD4/pub?embedded=true
[js]: https://docs.google.com/document/d/1gZ6WG6HBTJYHAtVkz9kzi_SUuzfXqzO-SvFnLuag2xM/pub?embedded=true
[css]: https://docs.google.com/document/d/1wA9paRA9cS7ByStGbhRRUZLEzEzimrNQjIDPVqy1ScI/pub
[html]: https://docs.google.com/document/d/12PJYbQoqjK-0LzaUuguQ4kGE--eikCcHfwzZDGwFOJ0/pub?embedded=true

[dev]: https://github.com/TEAMMATES/teammates/blob/master/devdocs/process.md

### Other Resources
If you are just starting out, do refer to the [Contributor's Orientation Guide][COG].
For a comprehensive directory of resources, please refer to [README.md][readme].

[cog]: https://docs.google.com/document/d/1cY9pmEmw4dC6Z4LjN1WUTsynJ0jVPgbWsFhdyBy_wCU/pub?embedded=true
[readme]: https://github.com/TEAMMATES/teammates/blob/master/README.md

0 comments on commit cc5bfef

Please sign in to comment.