Skip to content

Latest commit

 

History

History
104 lines (48 loc) · 4.19 KB

CONTRIBUTING.md

File metadata and controls

104 lines (48 loc) · 4.19 KB

How to contribute

This project is development as result of a university program for Neuroscience and Behaviour Laboratory in Biology Department of Universidade de Brasília (UnB), students are responsible for this code, but is built so that anyone willing to contribute can modify and help with development using github. This project was possible thanks to scientific research programs, financed by CNPQ and FAP-DF. In this file, that are some instructions and suggestions upon how to make your contribution, please read it before sending your changes.

Prerequisites

  • Microsoft Visual Studio 2015+
  • ResXManager extension for VS

Getting Started

To have access to our project you just have to clone this repository and open the .sln file (Microsoft Visual Studio Solution).

Globalization

This program is currently available on:

  • English
  • Portuguese

Releases are made with separate versions of each language. There are texts needing translation to spanish here so that it can also be available in spanish.

Localization is made by the use of resx files, managed on ResXManager a VS extension. Winform forms and usercontrols can be localizated only when their property "Localizable" is set true. Which of these files have a .resx for available languages that is used for static elements.

For dynamic elements, such as error messages displayed during run time, that are global resources located in:

Localization Resources

To use resources in global files

// properties used to localize strings during runtime
private ResourceManager LocRM = new ResourceManager("TestPlatform.Resources.Localizations.LocalizedResources", typeof(FormMain).Assembly);
private CultureInfo currentCulture = CultureInfo.CurrentUICulture;

// getting string "reactionTest" from resources in current culture
LocRM.GetString("reactionTest", currentCulture)

Data structure

There is no database in this application, instead files are used. Below there is an image of the directory tree created for the program.

Data structure

Testing

Unit tests are kept in their own project inside solution. Until now, that are only tests for model classes.

Tests project

You can run tests using visual studio default configurations.

Running tests

Submitting changes

Please send a GitHub Pull Request to TestPlatform stating what you've done. The Pull Request will only be accepted if the contribution works in all cultures (en-US and pt-BR).

Deployment

For this project deployment, follow the steps below (You need WinRAR to be installed in your computer)

  1. Change localization to specific culture that will be released. Don't forget to also change version in AssemblyInfo.cs (Inside Properties)

enter image description here

  1. Go to project properties and click on the left menu on publish, changing application files accordingly to culture being published. Then, click on the Publish Wizard

enter image description here

  1. Right click on the folder created after published, and click to add to file (using WinRAR).

  2. Use WinRAR advanced SFX options to create an executable of the compressed files

enter image description here

enter image description here