{"_id":"571d55ed59192d0e0072b271","__v":1,"parentDoc":null,"user":"54fb2a5f3dc1790d00b54206","version":{"_id":"571d54d418b3c10e003e55b9","project":"54fb204867c8370d00b5c269","hasDoc":true,"hasReference":true,"__v":3,"createdAt":"2016-04-24T23:20:52.805Z","releaseDate":"2016-04-24T23:20:52.805Z","categories":["571d54d418b3c10e003e55ba","571d54d418b3c10e003e55bb","571d54d418b3c10e003e55bc","586982e31c8ac62300359a78","5869833f6dab552500c677cb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2.0"},"category":{"_id":"571d54d418b3c10e003e55ba","version":"571d54d418b3c10e003e55b9","project":"54fb204867c8370d00b5c269","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-03-07T15:59:05.256Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"project":"54fb204867c8370d00b5c269","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-24T23:25:33.922Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"Thanks for your interest in contributing to the CS Blogs project. One of the main aims of the project was to expose more students, particularly those from The University of Hull, to the world of open source software development.\n\nThis document outlines how to contribute and some more technical information about the project to help you along the way.\n\n## Project Structure\n\nCS Blogs is split into 4 Git repositories:\n\n* **feed-downloader** is the system that aggregates users' blog feeds and syncs them with the CS Blogs database.\n* **api-server** provides the data via an API to any clients to make use of.\n* **web-app** is the web front-end for csblogs.com\n* **common** is a module which shares the database schemas between feed-downloader and api-server (or any other Node.js app that wishes to use it).\n\n## Branch Style\nBranch names should accurately portray the unit of work you are doing. They should follow the [WP Calypso](https://github.com/Automattic/wp-calypso/blob/master/docs/git-workflow.md) naming conventions:\n\n```\nadd/{something} -- When you are adding a completely new feature\nupdate/{something} -- When you are iterating on an existing feature\nfix/{something} -- When you are fixing something broken in a feature\ntry/{something} -- When you are trying out an idea and want feedback\n```","excerpt":"","slug":"contributing-to-cs-blogs","type":"basic","title":"Contributing to CS Blogs"}

Contributing to CS Blogs


Thanks for your interest in contributing to the CS Blogs project. One of the main aims of the project was to expose more students, particularly those from The University of Hull, to the world of open source software development. This document outlines how to contribute and some more technical information about the project to help you along the way. ## Project Structure CS Blogs is split into 4 Git repositories: * **feed-downloader** is the system that aggregates users' blog feeds and syncs them with the CS Blogs database. * **api-server** provides the data via an API to any clients to make use of. * **web-app** is the web front-end for csblogs.com * **common** is a module which shares the database schemas between feed-downloader and api-server (or any other Node.js app that wishes to use it). ## Branch Style Branch names should accurately portray the unit of work you are doing. They should follow the [WP Calypso](https://github.com/Automattic/wp-calypso/blob/master/docs/git-workflow.md) naming conventions: ``` add/{something} -- When you are adding a completely new feature update/{something} -- When you are iterating on an existing feature fix/{something} -- When you are fixing something broken in a feature try/{something} -- When you are trying out an idea and want feedback ```