Skip to content

Commit d7eecb3

Browse files
authored
Merge pull request #153 from codersforcauses/issue-96-contributors_documentation
Issue 96 contributors documentation
2 parents 7db25c2 + cc5e035 commit d7eecb3

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Contributors
2+
3+
Models that associate a member object with another certain object as a contributor to it. There are two types:
4+
5+
## Game Contributor
6+
7+
A model that will associate a certain member with having contributed to a certain game. A Game Contributor object will be represented under the 'Contributors' section of a game's page as the name of the member who contributed.
8+
9+
## Fields
10+
11+
**Game:** Required field for the game that the contributor is for. It is an integer field that corresponds to the raw integer id of a Game object in the Game table, known as a Foreign Key.
12+
13+
**Member:** Required field for the member that is the contributor to the specified game. It is an integer field that corresponds to the raw integer id of a Member object in the Member table, known as a Foreign Key.
14+
15+
**Role:** Required character field for the description of the role that the person played in contributing to the game. Maximum length of 100 characters
16+
17+
## Other Notes
18+
19+
You will see a little magnifying glass when selecting a Game and Member, click on it to see their respective table and be able choose the integer id's using the desired details. Though none of the individual fields are a primary key, the actual primary key is the unique (Game, Member) pair that each object forms.
20+
21+
22+
## Art Contributor
23+
24+
A model that will associate a certain member with having contributed to a certain artwork. An Art Contributor object will be represented under the 'Contributors' section of an artworks's page as the name of the member who contributed.
25+
26+
## Fields
27+
28+
**Art:** Required field for the artwork that the contributor is for. It is an integer field that corresponds to the raw integer id of an Art object in the Art table, known as a Foreign Key.
29+
30+
**Member:** Required field for the member that is the contributor to the specified artwork. It is an integer field that corresponds to the raw integer id of a Member object in the Member table, known as a Foreign Key.
31+
32+
**Role:** Required character field for the description of the role that the person played in contributing to the artwork. Maximum length of 100 characters
33+
34+
## Other Notes
35+
36+
You will see a little magnifying glass when selecting an Art and a Member, click on it to see their respective table and be able choose the integer id's using the desired details. Though none of the individual fields are a primary key, the actual primary key is the unique (Art, Member) pair that each object forms.

0 commit comments

Comments
 (0)