cardshifter.github.io

######Last revision: 2016-03-10

Cardshifter Website

This repository is related to the Cardshifter repository. Cardshifter is an open-source online card game.

The purpose of the website is to promote and inform the public and potential players and contributors about the Cardshifter game and project, and about its various modifications (mods).

Contributing Guidelines

If you wish to contribute, please take one of the following steps:

• Open a Github Issue.

• Create a pull request.

• Contact @Phrancis or @marcandregirard via Github.

• Join the chatroom on Stack Exchange and discuss how you can contribute.

Once you have committed changes to your fork or branch, create a pull request for the Cardshifter team to review, possibly recommending some changes if needed, and to merge to this repository for deployment.

###Deploying website updates

We have automated deployment of new website content on our Jenkins server, which is hosted and administered by @Zomis. To deploy:

1. Commit your changes to your branch or fork;

2. Create a pull request to merge to master branch on this repository;

3. After review by the Cardshifter team (and possible changes if needed), the pull request will be merged to master by Cardshifter team;

4. Deployment can take roughly up to an hour from pushing to master. Status updates will be posted by the Duga bot in our chat room on Stack Exchange.

Coding guidelines

The HTML and CSS source files are currently located in the following sub-directory:
/io.web/src/main/webapp/WEB-INF

Important note: If you wish to work directly on the project via branching or pull request, you will need a Java IDE as well as Maven and Tomcat server extensions. If you need help setting up please open an Issue and label it "Support Request", or join the chatroom on Stack Exchange.

HTML

• Do not use HTML properties, especially for formatting, unless absolutely necessary. Use CSS instead.

• Use spaces, rather than tabs, for indentation. Two spaces for small indentation (e.g., between <div> sections) and four spaces for large indentation (e.g. between large sections).

• Use only one additional line break if you wish to delimit parts of the document.

• Use page-template.html to add new pages. That file will always be up-to-date with layout and page elements.

• Place images in the images folder, and in the appropriate sub-folder (e.g., screenshots, logos, etc.)

• Sub-sites for mods should be isolated in their own folder, with same folder structure as the primary Cardshifter structure.

• Using hyphens - in file names. Do not use spaces or underscores.

CSS

• Use CSS 3 features as much as possible, for compatibility with future versions of major browsers.

• Keep site-wide changes into the cardshifter.css file. You can make CSS changes into the HTML if the change is to be applied only to that page, or temporarily for testing purposes.

• Prefix all classes in cardshifter.css with csh- so they can be more easily identified as a local CSS class, rather than a Bootstrap CSS class.

##Guidelines for images

Make sure to save images in the appropriate sub-folder. Do not save any images directly in the main io.web/src/main/webapp/images/ folder.

####Logos

• Folder: io.web/src/main/webapp/images/logos/

• Use for logos and similar branding images.

• These will normally be PNG files, and possibly SVG for vectorial images in some cases.

• Use descriptive naming. For example, use Twitter_logo_blue.png rather than Twitter.png.

####Screenshots

• Folder: io.web/src/main/webapp/images/screenshots/

• Use for game and other screenshots of the applications.

• These will usually be PNG files, unless they contain significant photographic (rasterized) elements, in which case use JPG.

• Use versioned naming to represent which application version they come from. Be sure to update the images.html file in WEB-INF so that the most current version is displayed on the site.

• Example naming for release 0.6: 0.6-deck-builder.png