Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added a LICENSE file, modofied CONTRIBUTING.md and now CSS and JS fil…
…es are included directly into graf.php
  • Loading branch information
avm99963 committed Dec 31, 2018
1 parent 9f5952a commit 36f9b9b
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 869 deletions.
33 changes: 15 additions & 18 deletions CONTRIBUTING.md
@@ -1,22 +1,19 @@
# Contributing
For the sake of safe and understandable code, we divide our JS scripts and CSS styles into multiples files. But, to make the page load faster, before committing, please run `sh concatenate.sh` so all those files are concatenated.
Hi there! If you want to contribute to build this alternative version of the Graf, you can do several things:

This will concatenate the files in the following way:
## Contribute with code
If you want to contribute by writing code, you can fork this repository, develop there, and then create a new pull request to merge your modifications into this repository.

The file script.js will be created with the concatenation of the following files: (in this order)
1. circle-mode.js
2. graf.js
3. limit-years.js
4. search-bar.js
5. dialog.js
6. camera.js
7. just-do-it.js
8. init.js
All help is welcome, but please make sure to test your code before creating the pull request and don't create multiple pull requests about a single feature. Also, try to follow the style of the code already written, which will make it look clean. These are some of the conventions we use (adapted from https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md):

The file styles.css will be created with the concatenation of the following files: (in this order)
1. general.css
2. graf.css
3. dialog.css
4. option-buttons.css
5. year-list.css
6. search-bar.css
* We indent using two spaces (soft tabs)
* We generally put spaces after list items and method parameters (`[1, 2, 3]`, not `[1,2,3]`) and around operators (`x += 1`, not `x+=1`). Some exceptions are when using increment and decrement operators (e.g. `i++`) or when multiplying, dividing, and even sometimes when summing or subtracting two numbers (e.g. `a*b`), although sometimes spaces are added to sums and subtractions to make it clear that multiplication and division have higher precedence (e.g. `a + b*c`).
* This is open source software. Consider the people who will read your code, and make it look nice for them. It's sort of like driving a car: Perhaps you love doing donuts when you're alone, but with passengers the goal is to make the ride as smooth as possible.

### About CSS and JS files
For the sake of understandable code, we divide our JS scripts and CSS styles into multiples files.

Before, we concatenated all these JS and CSS files into two single files which were included into `graf.php`, but as we now have `modspeed` running in our server (an Apache mod which, apart from other things, can combine CSS and JS files when serving pages) and this procedure was complex and tiring, we no longer need to do this, so we are now including all JS and CSS files directly to the `graf.php` page for the sake of simplicity.

## Contribute filling in bug issues or feature requests
Did you find out something is not working, or do you have an awesome idea about the alternative Graf? It would be great if you filled in a new issue! But just before you do that, check out that another issue about the same topic doesn't exist.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 The Alternative Graf Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
3 changes: 0 additions & 3 deletions concatenate.sh

This file was deleted.

303 changes: 0 additions & 303 deletions css/styles.css

This file was deleted.

0 comments on commit 36f9b9b

Please sign in to comment.