Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

We should merge now - BRANCH:New files order - WIP #75

Merged
merged 19 commits into from
Jul 18, 2017

Conversation

nicolasdb
Copy link
Member

@nicolasdb nicolasdb commented Jul 13, 2017

Je crée ce pull request pour discuter des modifs sur /tree/new-files-order
Je suis repartis de la logique conseillée dans les opensource.guide.

No matter which stage you decide to open source your project, every project should include the following documentation:

  • LICENCE.md
  • README.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md

As a maintainer, these components will help you communicate expectations, manage contributions, and protect everyone’s legal rights (including your own). They significantly increase your chances of having a positive experience.

If your project is on GitHub, putting these files in your root directory with the recommended filenames will help GitHub recognize and automatically surface them to your readers.

DONC

[folder]2repo
[folder]done
[folder]inprogress
[folder]xx-src
LICENCE.md
README.md
CONTRIBUTING.md
CODE_OF_CONDUCT.md

  • Importance d'avoir ces fichiers et ces noms là à la racine.
    On peut y ajouter les templates pour les issues et pull request.

De là, je pense qu'on doit tout mettre en dossier et relier via une table des matières dans le README.md

  • Je pense à un dossier RESOURCE ou SOURCE ou SRC où mettre les fichiers ressources/sources, les pdf, les documents de références, les images peut-être aussi.
    Peut-être considérer que ce sont des ressources extérieures.
    xx- permet de le trier à la fin (ordre alphabétique)

  • Comment séparer les fichiers validé du reste?
    Ce qui est validé, on parlait de l'ajouter dans le WIKI.

  • Je vais ajouter [folder]2repo pour trier ce qui pourrait/est modulaire ou transversale à d'autres sujets et qui devrai du coup faire l'object d'un REPO dédié.

@nicolasdb
Copy link
Member Author

Petite checklist pour démarrer un nouveau REPO:
https://opensource.guide/starting-a-project/#your-pre-launch-checklist

on pourrait faire pareil

And CODE_OF_CONDUCT still missing. c'est en cours dans une autre
branche.
@nicolasdb
Copy link
Member Author

J'en suis aujourd'hui à ça:

[folder]2repo
[folder]_event
[folder]_making
[folder]_network
[folder]_research
[folder]_space
[folder]xx-src
LICENCE.md
README.md
CONTRIBUTING.md
ISSUE_TEMPLATE.md

il manque le CODE of conduct et refaire un README + CONTRIBUTING
REvoir peut-être le template issue.

J'ai documenté un README dans chaque dossier pour expliquer son contenu. Je suis repartis d'un concept qu'on avait vu et utilisé avec Xavier il y a un tps dans nos concepts.
A MODULAR BUSINESS PLAN FOR THE CREATION OF DESIGN INNOVATION HUBS
image

C'était encore une recherche financée par l'europe et qui reste à mon gout encore bien obscure d'accès au publique.
C'est Elise Elsacker qui m'avait parlé de ça, et via via moulte recherche sur google, je suis tombé sur le pdf puis de fil en aiguille à ceci: http://proudeurope.eu/

Je pense que ça reste une bonne piste à reprendre pour des catégories de fichiers suivant le type d'activité principale que ça alimente.

@nicolasdb
Copy link
Member Author

HA et j'aimerai valider avec vous cette structure assez rapidement pour reprendre le développement sur une structure fraiche.

Qu'en pensez vous?

@nicolasdb nicolasdb changed the title Do not merge YET - BRANCH:New files order - WIP We should merge now - BRANCH:New files order - WIP Jul 16, 2017
@nicolasdb nicolasdb mentioned this pull request Jul 17, 2017
@softrevolter softrevolter merged commit 891cee5 into master Jul 18, 2017
@nicolasdb
Copy link
Member Author

ho tient, ils proposent d'effacer la branche après. intéressant et stressant quand même :p

@nicolasdb
Copy link
Member Author

haaa, intéressant aussi. Ils y a une différence avec des fichiers dans gamifications/mission et il les a laissé en place.

@nicolasdb nicolasdb deleted the new-files-order branch July 23, 2017 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants