Skip to content

Commit

Permalink
Add contributing and update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
smellems committed Oct 11, 2018
1 parent 6496a25 commit 69cac6a
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 8 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Contributing

([Français](#comment-contribuer))

## How to Contribute

See [data README file](_data) to learn how to contribute data about released open source code or open source software used by Canadian federal, provincial, territorial or municipal administration.

When contributing, post comments and discuss changes you wish to make via Issues.

Feel free to propose changes by creating Pull Requests. If you don't have write access, editing a file will create a Fork of this project for you to save your proposed changes to. Submitting a change to a file will write it to a new Branch in your Fork, so you can send a Pull Request.

If this is your first time contributing on GitHub, don't worry! Let us know if you have any questions.

______________________

## Comment contribuer

Voir le [fichier README des données](_data) pour savoir comment fournir des données sur le code source ouvert publié ou les logiciels libres utilisés par l'administration fédérale, provinciale, territoriale ou municipale du Canada.

Lorsque vous contribuez, veuillez également publier des commentaires et discuter des modifications que vous souhaitez apporter par l'entremise des enjeux (Issues).

N'hésitez pas à proposer des modifications en créant des demandes de tirage (Pull Requests). Si vous n'avez pas accès au mode de rédaction, la modification d'un fichier créera une copie (Fork) de ce projet afin que vous puissiez enregistrer les modifications que vous proposez. Le fait de proposer une modification à un fichier l'écrira dans une nouvelle branche dans votre copie (Fork), de sorte que vous puissiez envoyer une demande de tirage (Pull Request).

Si c'est la première fois que vous contribuez à GitHub, ne vous en faites pas! Faites-nous part de vos questions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,50 @@
## Open Resource Exchange Website
([Français](#échange-de-ressources-ouvert))

## Open Resource Exchange

https://canada-ca.github.io/ore-ero/home.html

Explore how the Government of Canada creates greater transparency, accountability, increases citizen engagement, and drives innovation and economic opportunities through open Standards, open source software, open data, open information, open dialogue and open Government.

### Contributing
### How to Contribute

See [CONTRIBUTING.md](CONTRIBUTING.md)

See [data README file](_data) to learn how to contribute data about released open source code or open source software used by Canadian federal, provincial, territorial or municipal administration.

This site uses [Jekyll](https://jekyllrb.com/) and [Github Pages](https://pages.github.com/). Create [Pull requests](pulls) to add functionnalities or fix bugs.

Create [Issues](issues) if you have any questions, bugs or feature requests.
Unless otherwise noted, the source code of this project is covered under Crown Copyright, Government of Canada, and is distributed under the [MIT Licence](LICENSE.txt).

### Development

To test your changes locally, run `jekyll serve`. For example using Docker:

> docker run -p 4000:4000 -v $(pwd):/srv/jekyll -it --rm jekyll/jekyll jekyll serve
________________
Site will be available at: http://localhost:4000/ore-ero/
______________________

## Site Web pour l'Échange de ressources ouvert
## Échange de ressources ouvert

https://canada-ca.github.io/ore-ero/accueil.html

Découvrez comment le gouvernement du Canada crée davantage de transparence et de responsabilisation, augmente la mobilisation citoyenne et favorise l’innovation et les possibilités économiques au moyen de normes ouvertes, logiciels libres, données ouvertes, d’information ouverte, de dialogue ouvert et du Gouvernement ouvert.

### Contribuer
### Comment contribuer

Voir [CONTRIBUTING.md](CONTRIBUTING.md)

Voir le [fichier README des données](_data) pour savoir comment fournir des données sur le code source ouvert publié ou les logiciels libres utilisés par l'administration fédérale, provinciale, territoriale ou municipale du Canada.

Ce site utilise [Jekyll](https://jekyllrb.com/) et [Github Pages](https://pages.github.com/). Créez des [requêtes Pull](pulls) pour ajouter des fonctionnalités ou corriger des bogues.

Créer des [Issues](issues) si vous avez des questions, des bogues ou des demandes de fonctionnalités.
Sauf indication contraire, le code source de ce projet est protégé par le droit d'auteur de la Couronne du gouvernement du Canada et distribué sous la [licence MIT](LICENSE.txt).

### Développement

Pour tester vos modifications localement, exécuter `jekyll serve`. Par exemple avec Docker:

> docker run -p 4000:4000 -v $(pwd):/srv/jekyll -it --rm jekyll/jekyll jekyll serve
Le site sera disponible au: http://localhost:4000/ore-ero/
2 changes: 1 addition & 1 deletion _data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ If your adminstration is there add your use of open source software under it, yo
##### Your open source software needs to be added
If your open source software does'nt have a file under the [logiciels_libres-open_source_software](logiciels_libres-open_source_software) directory, you need to create a new file for the open source software. Use the [ll-oss template with only mandatory fields](../_data_templates/ll-oss_mandatory.yml).

________________
______________________

## Données pour l'Échange de ressources ouvert

Expand Down

0 comments on commit 69cac6a

Please sign in to comment.