issues
search
dssg
/
givinggraph
An API tool to help understand the relationships between non-profits, for-profits, and the causes they support.
https://github.com/dssg/givinggraph/wiki/API
MIT License
28
stars
13
forks
source link
Repo Cleanup
#11
Closed
hunterowens
closed
10 years ago
hunterowens
commented
10 years ago
Directory Structure
[x] Clean, Well named set of directories. Examples include
webapp
,
database
, and
models
.
[x] No random files in the root.
[ ] Explanation of each directory in README.
[ ] Sub-README's in appropriate folders
[x] No directories named after DSSG specific info (ie, person names)
[x] Should your team have more than one project, each should have it its own repo.
[ ] In your
data
or
database
folder, provide a way to re-create your database from scratch.
.sql
files are often appropriate for this.
README
[ ] Links to appropriate sections in wiki. See wiki issue for more info.
[ ] Answers: What have you built? In a few sentences.
[ ] Answers: How do you install it?
[x] Answers: What needs to be done/How can I help?
[ ] Has some sort of Contact Info
[x] Open source license
[x] Future Issues opened.
Config
[x] No public facing config info - Make sure never to hardcode in database url, password, etc.
[x] Description of how you hide config info, ie yaml, environment variables, etc
[x] config.example files
[x] Requirements.txt or similar file.
[x] Relative links in any html.
Directory Structure
webapp
,database
, andmodels
.data
ordatabase
folder, provide a way to re-create your database from scratch..sql
files are often appropriate for this.README
Config