Skip to content

Commit

Permalink
docs(github): add contributions informations
Browse files Browse the repository at this point in the history
  • Loading branch information
anhgelus committed Jun 16, 2023
1 parent 55fcd00 commit fa966a4
Show file tree
Hide file tree
Showing 9 changed files with 412 additions and 0 deletions.
Empty file added .github/CODEOWNERS
Empty file.
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
name: "Bug Report"
about: "Open a bug report to help us identify issues."
title: "[Bug] <Put your title here>"
labels: "bug"
assignees: ""

---

<!--
##############################################################################
## WARNING! ##
## IGNORING THE FOLLOWING TEMPLATE WILL RESULT IN YOUR ISSUE BEING CLOSED ##
##############################################################################
-->

## Pre-Issue Checklist

<!--
You must put an x in all the boxes you have completed. (Like this: [x])
-->

- [ ] I have checked that I am on the latest version of this project.
- [ ] I have searched the github issue tracker for similar issues, including
closed ones.
- [ ] I have checked that this is an issue with this project and not an issue with something I am using.
- [ ] I have filled out and provided all the appropriate information.

## Environment

<!-- You can fill out the different items by putting the correct value beside each cell. -->

| Name | Value |
|------------------------------|-------|
| Version | <!-- Put your version here. (remove the comment) -->
| OS | <!-- Put your OS here. (remove the comment) -->

## Issue Description

<!--
Put a quick description of the issue here.
Example: 'When entering this command `foo bar`, the app is not responding.', etc.
-->

### Stacktrace

<!--
Put the stacktrace here
-->

### Steps to reproduce

<!--
Describe what you were doing when this happened.
Make sure to include ALL information. Including anything you were doing before that may have caused it.
-->

1. <!-- Put step #1 here. -->
2. <!-- Put step #2 here. -->
3. <!-- etc. -->

### Expected behavior

<!-- Describe what you think *should* happen here: -->

### Additional details

<!-- Any other information you think should be added -->
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
name: "Feature Request"
about: "Give us suggestions of features we could add."
title: "[Feat] <Put your title here>"
labels: "enhancement"
assignees: ""

---

<!--
########################################################################################
## WARNING! ##
## IGNORING THE FOLLOWING TEMPLATE WILL RESULT IN YOUR FEATURE REQUEST BEING CLOSED ##
########################################################################################
-->

### Pre-Request Checklist

<!--
You must put an x in all the boxes you have completed. (Like this: [x])
-->

- [ ] I have checked that I am on the latest version.
- [ ] I have searched github for similar features requests, including closed
ones, and found none.
- [ ] I believe this is within the scope of this project.
- [ ] This feature request is for *all* of this project, and isn't something that
should be implemented by a pack or addon.

## Feature Description

<!--
Quickly describe the basics of your feature request.
Example: 'Add a form to customize my experience'
-->

### What Problem Does This Solve?

<!--
Describe here what the issue is that you have.
Examples: 'When I do _______, it annoys me that _______ does _______.' or 'There is not enough customization in _______ to do _______.'
NOTE: This should NOT be used for a bug report. If this is unintentional, then please submit a bug report instead.
-->

### A Solution You'd Like

<!-- Provide a clear and accurate description of how you would like this to be solved. -->

### Alternative Solutions

<!-- Provide a description of alternatives you have considered to this. -->

1. <!-- Alternative #1. -->
2. <!-- Alternative #2. -->
3. <!-- Alternative #3. -->

### Additonal Context

<!--
Is there any additional context you would like to add?
If not, you may remove this section.
-->
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/other_issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: "Other Issue"
about: "Use this template if your issue doesn't accurately fit into any of the
other categories."
title: ""
labels: ""
assignees: ""

---

## Describe the issue

<!-- Please describe the issue as clearly and as concisely as possible, without missing any details. -->
115 changes: 115 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# Pull Request

## Brief description.

<!-- Please provide a brief description of the goals of your PR -->

<!--
###########################################################################
## WARNING! ##
## IGNORING THE FOLLOWING TEMPLATE WILL RESULT IN YOUR PR BEING CLOSED ##
###########################################################################
-->
<!--
Please go through this checklist item by item and make sure you have successfully completed each of these steps.
You must put an x in all the boxes you have completed. (Like this: [x])
-->
- [ ] Your pull request MUST be either on the latest version, or on a branch for a future release.
- [ ] Make sure that there are no already existing PRs that fix this. If so, it will be closed as a duplicate.
- [ ] Make sure that this change is actually within the scope of this project.
- [ ] Make sure that you have filled out all the required information and given descriptions of everything.
<!-- You can erase any parts of this template not applicable to your Pull Request. -->

### What Issues Does This Fix?

<!--
Put Fix #XXXX or Closes #XXXX here if there are any open issues that this PR fixes.
This is to automatically close the relevant issues.
You may remove this if there is no issue for this PR.
But unless this is a very small change, you should make an issue for it.
-->

## Licensing

<!-- In order to be accepted, your changes must be under the GPLv3 license. Please check one of the following: -->

- [ ] I am the original author of this code, and I am willing to release it
under this [License](./LICENSE).
- [ ] I am not the original author of this code, but it is in public domain or
released under this [License](./LICENSE) or a
compatible license.
<!--
Please provide reliable evidence of this.
NOTE: for compatible licenses, you must make sure to add the included license somewhere in the program, if so required.
(And even if it's not required, it's still nice to do it. Also add attribution somewhere.)
-->

## Goal of the PR

<!--
What is the goal of the PR?
Put a checklist here of what has been done
(and what *hasn't*, but you plan to do),
so we can easily know what was changed.
Note: this is only required for PRs that add new features.
If your PR is not adding new features, only fixing bugs or adding translations, then you may delete this section.
-->

- [ ] <!-- First thing -->
- [ ] <!-- A requirement of the first thing. -->
- [ ] <!-- A second requirement of the first thing. -->
- [ ] <!-- Second thing -->
- [ ] <!-- etc. -->

## Affects of the PR

<!---
What types of changes does your code introduce? (Select any that apply. You may select multiple.)
You must put an x in all the boxes that it applies to. (Like this: [x])
-->

#### Types of changes

- [ ] Bug Fix <!-- Anything which fixes an issue. -->
- [ ] Build system <!-- Anything which pretain to the build system. -->
- [ ] Documentation <!-- Anything which adds or improves documentation for existing features. -->
- [ ] New Feature <!-- Anything which adds new functionality. -->
- [ ] Performance <!-- Anything which is imrpoves the performance. -->
- [ ] Refactoring <!-- Anything which does not add any new code, only moves code around. -->
- [ ] Repository <!-- Anything which affects the repository. Eg. changes to the `README.md` file. -->
- [ ] Revert <!-- Anything which reverts previous commits. -->
- [ ] Style <!-- Anything which updates style. -->
- [ ] Tests <!-- Anything which adds or updates tests. -->
- [ ] Translation <!-- Anything which is internationalizing to other languages. -->

#### Compatiblity

- [ ] Breaking change <!-- A fix, or a feature, that breaks some previous functionality. -->
- [ ] Non-Breaking change.
<!--
A change which does not break *any* previous functionality.
(ie. is backwards compatible and will work with *any* previously existing supported features.
Note: if a feature is annotated with @Incubating, @Preview, @Experimental,
or is in a package called something similar to the previous annotations,
then you may push breaking changes to only THOSE parts.)
-->

#### Contribution Guidelines.

- [ ] I have read the [`CONTRIBUTING.md`](./CONTRIBUTING.md) document in the root of the git repository.
- [ ] My code follows the code style for this project.

#### Documentation

- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.

#### Testing

- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
<!--
If it only introduces small changes, you don't need to add tests.
But if you add big changes, you should probably at least write *some* testing, where applicable.
-->
19 changes: 19 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Preamble

These rules are based on the following essential principles:
1. All contributors are treated equally, no matter who they are.
2. The only applicable law is French law.
3. No one may dispense justice. This right and duty is reserved to the @Staff.
4. Total respect of the __Déclaration du Droits de l'Homme et du Citoyen__ which is extended to the Woman and the Citizen.
5. Every contributors knows these rules.
6. Everything that is not explicitly forbidden is authorized.

## The code

1. The rules may be updated.
2. Inappropriate, inappropriate, vulgar, hateful or violent comments, profile photos or nicknames are forbidden and will result in permanent banishment.
3. Attempting or raiding this repository is forbidden, and will result, without exception, in a permanent ban.
4. Spamming a contributor is forbidden, one mention is enough under penalty of permanent ban.
5. Mentioning unnecessary problems is forbidden.
6. All links, videos... are allowed as long as they respect the rules.
7. Double accounts are not allowed under penalty of perm ban.
107 changes: 107 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
# General MSMP contribution guidelines

Thank you for investing your time in contributing to our project!

First of all, don't forget to read our [Code of Conduct](./CODE_OF_CONDUCT.md).

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

## Issues

In this section, we'll talk about the "issue" part.

### Create a new issue

If you spot a problem, [search if an issue is already open](https://docs.github.com/en/search-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments).
If a related issue doesn't exist, you can open a new issue using the "Issues" tab.

When you create a new issue, use our issue template and fill every required informations.

### Solve an issue

If you want to solve an issue, search an existing issue and make a PR to fix it.

## Pull Requests (PR)

In this section, we'll talk about the "PR" part.

### Disclaimer

In this section, we'll not talk on "how to use git or github", we'll just talk about how we works with PR in this project.

### Create a PR

Before creating a PR, search if a related PR is already open.

When you create a new PR, use our PR template and fill every required informations.

### Editing our code

When you are editing our code to make a new PR, you must follow our standards.

#### Commit

One commit is one changes!

Commit namings:
- Your name is composed in 3 parts: `prefix(section): details`
- `prefix` describe the type of changes.
- `section` describe the part affected by your commit (flatcase).
- `details` describe your changes (flatcase).

Prefixes:
> `build` - affects the build part (gradle, npm, etc)
>
> `ci` - affects the continuous integration (git, github actions, etc)
>
> `feat` - add a new feature
>
> `fix` - fix a bug
>
> `perf` - improves performance
>
> `refactor` - changes that brings no new functionality or performance improvements
>
> `style` - changes that do not alter function or semantics (indentation, formatting, etc.)
>
> `docs` - changes related to the documentations
>
> `test` - changes related to the test
The details part must not exceed 70 characters in length.

When your commit contains a breaking change, use this format: `prefix(part)!: details`

#### Branch

Understand the branch system is very important.

The default branch is `main` and no one can push changes directly to this branch.
We must create a new branch and merge it through a PR if we want to modify the `main` branch.

Branch namings:
- Your name is composed in 2 parts: `prefix/details`
- `prefix` describe the type of changes. These are the same as the commits.
- `details` describe your changes (kebab case).

#### Tag

Basically, you are not autorized to add tag to your changes.

We follow the [semver](https://semver.org/).
So a tag is composed by: `M.m.p` (e.g. 1.2.3).
- `M` is the major version.
- `m` is the minor version.
- `p` is the patch version.

Major is increased when a new breaking changes is introduced.
Minor is increased when a new features is introduced.
Patch is increased when other changes is introduced.

### Reviewing PR

When you make your PR finished, we'll review your PR.

If everything is good, we'll merge it and close the PR.

If something is not good, we'll start a conversation and you must fix this before merging.
Loading

0 comments on commit fa966a4

Please sign in to comment.