-
Notifications
You must be signed in to change notification settings - Fork 95
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: contribution guide. #222
Merged
Merged
Changes from 76 commits
Commits
Show all changes
87 commits
Select commit
Hold shift + click to select a range
3edd6a4
feat: adds 3 parts of contribution guide.
white-gorilla e99e7d0
feat : add the code of conduct to the root (so that github marks it a…
white-gorilla a5872a3
fix : renames code of conduct file.
white-gorilla ace2307
fix : removes CODE_OF_CONDUCT.md
white-gorilla e18b99b
fead : adds CODE_OF_CONDUCT.md to the root.
white-gorilla ff0087a
feat: adds CODE_OF_CONDUCT.md to the root.
white-gorilla 556c79a
feat : update CODE_OF_CONDUCT.md to 2.1.
white-gorilla 7675a70
Revert "feat : update CODE_OF_CONDUCT.md to 2.1."
white-gorilla 26bd284
Merge branch 'feat/contribution-guide-doc' of https://github.com/ELS-…
white-gorilla ec9e68f
feat: update CODE_OF_CONDUCT.md to 2.1.
white-gorilla 0a78eaa
feat: update CODE_OF_CONDUCT.md to 2.1.
white-gorilla 08f27b4
feat: makes the email alert clickable.
white-gorilla cf41f77
docs: contributing - who can participate.
white-gorilla c2c0bcb
docs: contributing - who can participate.
white-gorilla cacc310
docs: adds contributing documentation.
white-gorilla 6a8b034
Merge branch 'feat/contribution-guide-doc' of https://github.com/ELS-…
white-gorilla 1dd31e3
Merge branch 'main' into feat/contribution-guide-doc
white-gorilla 33d0ff1
fix: adds links to the contribution guide on the landing page.
white-gorilla b420e11
refactor: renames how-to-contribute file to contributing-guidelines.
white-gorilla c3dabd5
fix: loading chart.js script only on the home page.
white-gorilla f13f76f
fix: remove unnecessary loading of chart.umd.js.map.
white-gorilla 4506314
feat: adds pre-requisites and global information.
white-gorilla 5c74ee9
docs: update contributing.md.
white-gorilla 944a119
docs: update and refactor how-to-contribute.md.
white-gorilla faf4506
docs: update how-to-contribute.md.
white-gorilla d73446c
docs: update how-to-contribute.md.
white-gorilla 20bdea6
docs: update contributing.md.
white-gorilla 5aeece9
feat: add a bug report template.
white-gorilla 102e3b1
docs: update contributing.md.
white-gorilla 0efd71c
docs: update bug-report.yml.
white-gorilla ccf3faf
docs: update how-to-contribute with bug report issues.
white-gorilla 4477623
docs: topics reorganization in how-to-contribute.
white-gorilla f71ff46
feat: adds c.o.c validation.
white-gorilla 7958957
feat: adds c.o.c validation to bug-report template.
white-gorilla 6ca8211
feat: adds title to bug-report template.
white-gorilla 4119ce2
Merge branch 'feat/contribution-guide-doc' of https://github.com/ELS-…
white-gorilla c3c54a9
docs: adds feature requests and minor changes.
white-gorilla 9d87d8a
fix: validations on bug-report.yml.
white-gorilla cfb724c
fix: adds recommandations.
white-gorilla 6591672
refactor: renames bug-report.yml to bug.yml.
white-gorilla 187c9f1
refactor: renames bug-report.yml to bug.yml.
white-gorilla 15f2e24
refactor: renames bug-report.yml to bug.yml.
white-gorilla 6138cda
feat: adds feature template.
white-gorilla 1de7811
fix: minor change.
white-gorilla 9612ffa
refactor: format.
white-gorilla fb51fd6
feat: finalize feature template.
white-gorilla ced976f
feat: finalize feature template.
white-gorilla 3c8782a
doc: add validation link to feature template and remove old feature r…
white-gorilla e9874d0
doc: add proposals section.
white-gorilla f888df8
doc: change issues order.
white-gorilla 3625fde
fix: add or change title in templates.
white-gorilla bf44104
fix: add proposal template.
white-gorilla 6f2b770
fix: update info for reviewers.
white-gorilla f8b02e5
fix: update info for reviewers.
white-gorilla 63507a6
doc: add branch organization.
white-gorilla 794b01f
docs: update branch specification.
white-gorilla 51e2f9c
feat: adds documentation template.
white-gorilla 05f03fe
fix: minor change on proposal template.
white-gorilla 6d3ab05
fix: minor change on feature template.
white-gorilla 7871058
fix: minor change on documentation template.
white-gorilla fcf391b
doc: minor change.
white-gorilla 1c3684a
doc: adds writing a good commit message.
white-gorilla 15b9177
doc: minor change.
white-gorilla 1a8b2d1
docs: adds pull requests section.
white-gorilla 624a257
Merge branch 'main' into feat/contribution-guide-doc
white-gorilla cd4bedb
docs : installation, startup, test... from the README file.
white-gorilla c4da08f
Merge branch 'main' into feat/contribution-guide-doc
white-gorilla a57cbd7
Merge branch 'main' into feat/contribution-guide-doc
white-gorilla 45f0af9
fix : feel free to consult the contribution guide link.
white-gorilla 4707024
fix : contribution links.
white-gorilla e94377f
docs : add contributing and c.o.c to the readme file.
white-gorilla 31da837
docs : added the PR in draft.
white-gorilla 725abcc
fix : ignore DS_Store.
white-gorilla e1fa44d
feat : add self-service to bug template.
white-gorilla 4a829e2
docs: remove bold on bug reproduction.
white-gorilla 65b58a0
Merge branch 'main' into feat/contribution-guide-doc
white-gorilla c07b1cb
docs: minor change.
white-gorilla 8337bdf
fix: discussion forum link and remove @previewer.
white-gorilla 39326bd
fix: remove @previewer.
white-gorilla e29b5b0
fix: discussion forum link and remove @previewer.
white-gorilla 1e38c4a
fix: remove @previewer.
white-gorilla cd64782
fix: discussion forum link and remove @previewer.
white-gorilla 6811b72
fix: a typo.
white-gorilla 62487df
fix: removes installation instructions.
white-gorilla 287db89
fix: minor change.
white-gorilla 0104357
fix: links to dedicated issues.
white-gorilla 53a9ac3
feat: adds config. issues.
white-gorilla File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
name: 🐛 Bug Report | ||
description: Submit a bug report to help us improve. | ||
title: "bug: " | ||
labels: | ||
- ["bug:unverified", 'status:needs triage'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for your help in improving kernl by reporting bugs. | ||
|
||
Before you create your issue. | ||
|
||
- Make sure the bug has not already been reported in the issue tracker. | ||
- Make sure it is reproducible. | ||
- Make sure you have enough material to fuel the search and resolution. | ||
|
||
Please fill out the form below to help us better understand the problem. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: A clear and concise description of what the bug is. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Steps to reproduce | ||
description: Steps to reproduce the bug. | ||
placeholder: | | ||
1. Step 1... | ||
2. Step 2... | ||
3. Step 3... | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Expected Behavior | ||
description: A concise description of what you expected to happen. | ||
placeholder: Write what you thought would happen. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Actual Behavior | ||
description: A concise description of what you're experiencing. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Your environment | ||
description: Include as many relevant details about the environment you experienced the bug in. | ||
value: | | ||
- Operating system and version (e.g. Ubuntu 20.04.2 LTS): | ||
- Python version (e.g. Python 3.8.10): | ||
- Python package manager (e.g. pip 21.1.2): | ||
- etc. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Self-service | ||
description: | | ||
If you think you can help fix this bug, please check the box below. This lets us know that someone wants to work on it. | ||
If you check this box, please send a Pull Request within 7 days of a maintainer's approval so we can delegate this task. | ||
options: | ||
- label: I would be willing to help fix this bug myself. | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.kernl.ai/contribution-guide/code-of-conduct/) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: 📚 Documentation | ||
description: Report an issue related to documentation | ||
title: "docs: " | ||
labels: [documentation, 'status: needs triage'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your help to improve kernl. | ||
|
||
This template is strictly used for documentation requests. | ||
|
||
For example: | ||
- Adding or modifying documentation. | ||
- Adding or modifying tutorials. | ||
- ... | ||
|
||
> This issue should not touch the code base. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: A clear and concise description of what the issue is. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Self-service | ||
description: | | ||
If you feel like you could contribute to this issue, please check the box below. This lets us know that someone wants to work on it. | ||
If you check this box, please send a Pull Request within 7 days of a maintainer's approval so we can delegate this task. | ||
options: | ||
- label: I would be willing to contribute to this issue myself. | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://www.kernl.ai/contribution-guide/code-of-conduct/) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: 💅 Feature | ||
description: Submit a detailed feature request with a concrete proposal. | ||
title: "feature: " | ||
labels: [feature, "status: needs triage"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your help to improve kernl. | ||
|
||
Important stuff: | ||
|
||
- We expect you to submit a real feature request and not just a basic idea. | ||
- The proposal doesn't have to be perfect, but it does have to be sufficiently elaborate. We will discuss and correct it if necessary. | ||
- For a more "casual" feature request, consider using the discussion forum. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Description | ||
description: A clear and concise description of what the feature is (be as complete as possible). | ||
validations: | ||
required: true | ||
|
||
- type: input | ||
attributes: | ||
label: Is this request already on the discussion forum? | ||
description: Please post the link, it is useful to determine the interest in this feature. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
description: Please outline the motivation for the proposal and why it should be implemented. | ||
validations: | ||
required: true | ||
|
||
- type: textarea | ||
attributes: | ||
label: Have you tried to implement it? | ||
description: | | ||
Please explain how you tried to create this feature by yourself and how you succeeded. | ||
|
||
If you can't create it yourself for technical reasons, please tell us why. We are ready to help you. | ||
|
||
> If your feature request is just an idea at the moment, please use the discussion forum. | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Self-service | ||
description: | | ||
If you answered the above question with "no" because you think you can contribute directly to the repository, please check the box below. This lets us know that someone wants to work on it. | ||
If you check this box, please send a Pull Request within 7 days of a maintainer's approval so we can delegate this task. | ||
|
||
> Note that for feature issues, we always ask that you fill out this form completely so that we can reach a consensus and not waste your time. | ||
options: | ||
- label: I would be willing to contribute to this feature myself. | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this feature, you agree to follow our [Code of Conduct](https://www.kernl.ai/contribution-guide/code-of-conduct/) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
name: 💥 Proposal | ||
description: Propose a non-trivial change to kernl | ||
title: "proposal: " | ||
labels: [proposal, 'status: needs triage'] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your help to improve kernl. | ||
|
||
An example of a proposal might be: | ||
|
||
- A significant improvement. | ||
- Significant refactoring. | ||
- A major version upgrade of a critical dependency. | ||
- ... | ||
|
||
You are free to write a proposal. But you must explain why you think this change is really beneficial, and what steps we should take to make it happen. | ||
|
||
> This is not a feature request, or a bug fix. | ||
|
||
- type: textarea | ||
attributes: | ||
label: Motivation | ||
description: A clear and concise description of what the proposal is. | ||
validations: | ||
required: true | ||
|
||
- type: checkboxes | ||
attributes: | ||
label: Self-service | ||
description: | | ||
If you feel like you could contribute to this proposal, please check the box below. This lets us know that someone wants to work on it. | ||
If you check this box, please send a Pull Request within 7 days of a maintainer's approval so we can delegate this task. | ||
|
||
> Proposals usually involve significant changes to the code. Please reach a consensus with those responsible before implementing them. | ||
options: | ||
- label: I would be willing to contribute to this proposal myself. | ||
|
||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this proposal, you agree to follow our [Code of Conduct](https://www.kernl.ai/contribution-guide/code-of-conduct/) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,3 +4,6 @@ venv/ | |
__pycache__/ | ||
*.egg-info/ | ||
site/ | ||
|
||
# Misc | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,132 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, caste, color, religion, or sexual | ||
identity and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall | ||
community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of | ||
any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, | ||
without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject | ||
comments, commits, code, wiki edits, issues, and other contributions that are | ||
not aligned to this Code of Conduct, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
<open.kernl.ai@gmail.com>. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series of | ||
actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or permanent | ||
ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the | ||
community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.1, available at | ||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at | ||
[https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
utile une checkbox pour ça ?
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.
This is a practice seen to identify a person ready to really contribute. Tell me if it's overkill or too restrictive.