-
Notifications
You must be signed in to change notification settings - Fork 1
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
docs(common): add contributing information #23
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# Contributor Code of Conduct | ||
|
||
## Version 1.0 | ||
|
||
As contributors and maintainers of the TalkControl organisation, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities. | ||
|
||
Communication through any of TalkControl's channels (GitHub, Gitter, IRC, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct. | ||
|
||
We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to TalkControl projects to do the same. | ||
|
||
If any member of the community violates this code of conduct, the maintainers of the TalkControl organisation may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate. | ||
|
||
If you are subject to or witness unacceptable behavior, or have any other concerns, please contact us. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
In order to run the project locally, you will need these tools: | ||
|
||
# Tools | ||
|
||
**NVM** : https://github.com/creationix/nvm | ||
|
||
> Using nvm, install node 20.x.x | ||
|
||
# Commit | ||
|
||
Please respect theses guidlines when contributing with commits : https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit | ||
|
||
Summary: | ||
|
||
``` | ||
<type>(<scope>): <short summary> | ||
│ │ │ | ||
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. | ||
│ │ | ||
│ └─⫸ Commit Scope: common|core|theme | ||
│ | ||
└─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|test|chore | ||
``` | ||
|
||
# Run Locally | ||
|
||
To run the project: | ||
|
||
1. run `nvm use` if you have nvm installed | ||
2. run `npm ci` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On a pas cette commande, du coup, je pense qu'il faut l'enlever |
||
3. run `npm start` | ||
|
||
# Deploy | ||
|
||
For the moment, there is no deployment. But when it will be available, you will use `npm run release` | ||
|
||
## Errors | ||
|
||
If you got a "System limit for number of file watchers reached" error , take a look at this solution : [StackOverFlow Watching Error](https://stackoverflow.com/questions/16748737/grunt-watch-error-waiting-fatal-error-watch-enospc/17437601#17437601) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,14 @@ | ||
# Talk-Control-RevealJS-Extensions | ||
|
||
<img src="./public/talk-control.png" style="max-width: 200px;display:block;margin: auto" /> | ||
<p align="center"> | ||
<a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/TalkControl/talk-control-revealjs-extensions/c81a3bb79852b61382e2a97444f5088d6102b3ec/public/talk-control.png" width="200" alt="TalkControl Logo"></a> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. c'est fait exprès que ça pointe vers laravel :p ? L'image, on pourrait pas sinon la faire pointer vers le repo ? en path référentiel ? |
||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/TalkControl/talk-control-revealjs-extensions/actions"><img src="https://github.com/TalkControl/talk-control-revealjs-extensions/actions/workflows/main.yml/badge.svg" alt="Build Status"></a> | ||
<a href="https://github.com/TalkControl/talk-control-revealjs-extensions/blob/main/LICENSE"><img src="https://img.shields.io/github/license/TalkControl/talk-control-revealjs-extensions" alt="License"></a> | ||
</p> | ||
|
||
## About TalkControl | ||
|
||
TalkControl aims to provides an easy to use extensions for anyone wanted to create slides with [reveal.js](https://github.com/hakimel/reveal.js). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ici, j'enlèverais la partie IRC/Google+, ça fait un peu oldschool :D. Je mettrais à la limite Discord en remplacement