forked from rooftopsparrow/resource-locking
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request rooftopsparrow#4 from rooftopsparrow/start-docs
Initial doc structure
- Loading branch information
Showing
3 changed files
with
38 additions
and
1 deletion.
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 |
---|---|---|
@@ -1,2 +1,7 @@ | ||
# resource-locking | ||
Circular Storage with Partial State Operations | ||
|
||
Circular Storage with Partial State Operations. | ||
|
||
## Documentation | ||
|
||
All process documentation and other resources can be found in the [documentation](./docs) directory of this project. |
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,8 @@ | ||
# Documentation | ||
|
||
One of the main requirements and objectives of the project is extensive documentation; not only of the product itself, but | ||
also of the process. Here you will find all relevant documentation of the entire lifecycle of the project. | ||
|
||
## Table of Contents | ||
|
||
1. [Initial Team decisions](./initial-team-decisions.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,24 @@ | ||
# Initial Team Decisions | ||
|
||
This document lays out an initial set of decisions made at the beginning of the project to | ||
all get on the same page. | ||
|
||
## Communication | ||
|
||
Primary communication was decided that we'd talk through [Slack](https://slack.com) in a new team for this project. | ||
We also decided that we'd make more communication, process, discussion changes in slack, as most of the team had very | ||
different schedules and in person communication is pretty hard to achieve. | ||
|
||
## Version Control | ||
|
||
The main version control tool we decided to use was [git](https://www.git-scm.com), and specifically using the | ||
hosted git service: [github](https://github.com/rooftopsparrow/resource-locking). We would be using the public and free tier | ||
of the platform. | ||
|
||
## Project Management | ||
|
||
It was proposed to use the built in tools in github like issues and milestones to track project assignments, design discussions, task delegation, and longer async communication. Consensus not reached yet. | ||
|
||
## Build Tools | ||
|
||
It was proposed to use maven or gradle, or some other build others that the team was comfortable with. Consensus not reached yet. |