Commit 65e14202 authored by Alexander Martinez's avatar Alexander Martinez
Browse files

agregar contributing

parent ae737681
# Contributing to LA-CoNGA physics
:tada::balloon::cake: **Welcome to _LA-CoNGA Physics_ repository!** :cake::balloon::tada:
:dizzy::hatched_chick::sunny: _We're excited that you're here and want to contribute._ :sunny::hatched_chick::dizzy:
Welcome to LA-CoNGA physics repository, and thank you for thinking about contributing!
The point of this file is to make it as easy as possible for you to get involved.
We need experts (researchers and teachers) in the Advanced physics for curricula design, in interconnected instrumentation, in data management (particularly ensuring the highest quality data protection plans are in place), in communication, in fundraising, app development, user experience design and documentation.
If you think you can help in any of the areas listed above (and we bet you can) or in any of the many areas that we haven't yet thought of (and here we're sure you can) then please check out our contributing guidelines below for more information on how to get started.
Please note that it's very important to us that we maintain a positive, open, safe and supportive learning environment for everyone who wants to participate. When you join us we ask that you follow [our code of conduct](CODE_OF_CONDUCT.md) in all interactions both on and offline.
If you have any questions that aren't discussed below, please let us know through one of the many ways to [get in touch](#get-in-touch).
## Table of contents
Been here before? Already know what you're looking for in this guide? Jump to the following sections:
- [Joining the community](#joining-the-community)
- [Inclusivity](#inclusivity)
- [Where to start](#where-to-start)
- [_LA-CoNGA Physics_ platform](#la-conga-physics_-platform)
- [Other Resources](#other-resources)
## Joining the community
_LA-CoNGA Physics_ is an [Erasmus+ Capacity Building](https://ec.europa.eu/programmes/erasmus-plus/opportunities/organisations/innovation-good-practices/capacity-building-higher-education_en) project, an European-Latinamerican network which aims to support the modernization of the university infrastructure and the pedagogical offer in advanced physics in four Latin American countries. We, therefore, require that all our members and their contributions **adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) (CoC)**. Please familiarize yourself with our [CoC](CODE_OF_CONDUCT.md) that lists the expected behaviours.
## Inclusivity
_LA-CoNGA Physics_ aims to be inclusive to people in **Advanced Physics**. These intentions must be reflected in the contributions that we make to the project.
In addition to the [CoC](CODE_OF_CONDUCT.md), behavior in each LA-CoNGA scenario must respect diversity and promote equity and inclusion, as mentioned in our **[Diversity Plan](diversity_plan.md)**.
We encourage intentional, inclusive actions from contributors to _LA-CoNGA Physics_. Please use respectful, gender-neutral and inclusive language (learn more about [inclusive writing](https://www.le.ac.uk/oerresources/ssds/studyskills/page_37.htm), resource by University of Leicester).
## Where to start :point_right: LA-CoNGA Platform
> Please contact our IT manager by email at [alexanderm2@protonmail.com](#mailto:alexanderm2@protonmail.com) to get your credentials for *LA-CoNGA Platform*.
### _LA-CoNGA Physics_ platform
_LA-CoNGA Physics_ activities are supported and/or developed through a set of tools which form the _LA-CoNGA Physics_ platform. These tools seek to manage aspects such as communication, online classes, content preservation or computational calculation in the best way. Below each tool is described.
- **Mattermost** available at https://mattermost.redclara.net. A messaging service focused on communication management for workgroups.
- **GitLab** available at https://gitmilab.redclara.net. A [Git-based](https://git-scm.com/) collaborative software development and version control web tool.
- **JupyterHUB** available at https://jupyter.redclara.net. A multi-user interactive computing web service.
- **ECMS** (Educational content management service) available at https://laconga.redclara.net/courses. A service to manage educational contents for *LA-CoNGA Physics* courses.
- LA-CoNGA Physics **website** available at https://laconga.redclara.net. Official web site for *LA-CoNGA Physics* project.
Aditionally we have a set of templates availabe at [LA-CoNGA Physics templates](docs/laconga_platform.md#templates-la-conga) to support the creation of contents.
You can find more details on these tools in [LA-CoNGA Platform Guides](docs/laconga_platform.md)
### Other Resources
#### Writing in Markdown
Most of the writing that you'll do in most of the services of the _LA-CoNGA Physics_ platform will be in [Markdown][markdown].
You can think of Markdown as a few little symbols around your text that will allow GitHub to render the text with a little bit of formatting.
For example, you could write words as **bold** (`**bold**`), or in _italics_ (`_italics_`), or as a [link][rick-roll] (`[link](https://youtu.be/dQw4w9WgXcQ)`) to another webpage.
For a detailed guide on how to write in markdown visit the [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) by [Adam Pritchard](https://github.com/adam-p).
[_The Turing Way_ style guide](https://the-turing-way.netlify.app/community-handbook/style.html) will provide guidance and supporting resources for ensuring consistency, readability and accessibility for all our users.
---
_These Contributing Guidelines have been adapted from the [Contributing Guidelines](https://github.com/alan-turing-institute/the-turing-way/blob/master/CONTRIBUTING.md) of the [turing Way Community](https://github.com/alan-turing-institute/the-turing-way)! (License: CC-BY)_
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment