Skip to content

Commit 3f1a11b

Browse files
authored
Add more content to contributing section (#85)
Co-authored-by: Simon Shillaker <[email protected]>
1 parent 6262675 commit 3f1a11b

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -401,7 +401,25 @@ serverless logs --function <function_or_container_name>
401401

402402
## Contributing
403403

404-
This plugin is mainly developed and maintained by `Scaleway Serverless Team` but you are free to open issues or discuss with us on our [Community Slack Channels](https://scaleway-community.slack.com/) #serverless-containers and #serverless-functions.
404+
This plugin is developed and maintained by the `Scaleway Serverless Team`, but we welcome pull requests and issues, and are available to chat on our [Community Slack Channels](https://scaleway-community.slack.com/) #serverless-containers and #serverless-functions.
405+
406+
General information on developing Serverless Framework plugins can be found [here](https://www.serverless.com/framework/docs/guides/plugins/creating-plugins).
407+
408+
To run Serverless Framework with your local checkout of this plugin, you can modify the `serverless.yml` for one or more functions as follows:
409+
410+
```yaml
411+
...
412+
413+
# Change this
414+
plugins:
415+
- serverless-scaleway-functions
416+
417+
# To this
418+
plugins:
419+
- <path to checkout of this project>
420+
```
421+
422+
Then you can run commands as normal.
405423
406424
## License
407425

0 commit comments

Comments
 (0)