rlespinasse/github-slug-action
1
0
Fork 0
mirror of https://github.com/rlespinasse/github-slug-action.git synced 2026-06-13 18:11:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve overview section

Browse Source
This commit is contained in:
Romain Lespinasse
2021-04-02 16:14:40 +02:00
committed by Romain Lespinasse
parent 8c0a3268b6
commit 08cd74e0fa
2 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@@ -18,7 +18,7 @@ Include the relevant issue number if applicable.
## Do you intend to add a new feature or change an existing one ## Do you intend to add a new feature or change an existing one
* Suggest your change by [opening a 'Feature request' issue][5] and start writing code. * Suggest your change by [opening a 'Feature request' issue][5] and start writing code (following the [developers guide](DEVELOPERS.md))
## Do you have questions about the source code ## Do you have questions about the source code

12
DEVELOPERS.md
View File

@@ -1,11 +1,15 @@
# Developers guide # Developers guide
## Prepare
Install the dependencies Install the dependencies
```bash ```bash
npm install npm install
``` ```
## Develop
Build the typescript and package it for distribution Build the typescript and package it for distribution
```bash ```bash
@@ -24,3 +28,11 @@ $ npm test
... ...
``` ```
## Contribute
Before creating a commit, validate your changes and build the associated distribution files
```bash
npm run all
```