Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

35 lines (28 loc) · 2.17 KB

Contribution Guidelines

Table of Contents

Introduction

This document explains how to contribute changes to EpitechCriterionActions project.It is strongly advised to read this document before even starting the development of a contribution.

Discuss

All contributions are welcome, however it is necessary to ensure that all the information described in this document is known and that all the rules are respected.

To propose modifications, it is necessary to create an issue by following the proposed template. During all the interactions on the project, it is important to explain and document all of what is said.

Code review

All changes made must be verified by other users before being incorporated.

In order to facilitate verification, it is advisable to proceed with small but multiple pull requests and issues.

It is strongly advised to follow the standard of the latest commits of the project.

In case of action changes, please put the link of a functional test repository as indicated in the tests section.

Language

All interactions on the project must be done in English.

Building

To start the action, you must create a project as indicated in the README. It is recommended to use the sample project as a basis.

Testing

In case of modifications of the action, it will be necessary to indicate in the pull request a link to a public repository based on the example project which works with the new version of the proposed action.

If changes had to be made to the test project, they must be explained.

Furthermore, it may be interesting to open an issue on the official example project at the same time so that it remains in accordance with the way of using epitech criterion actions.