Skip to content

Latest commit

 

History

History
118 lines (64 loc) · 6.39 KB

CONTRIBUTING.md

File metadata and controls

118 lines (64 loc) · 6.39 KB
Raw

Contributing Guidelines

We are always looking to promote good contributors to be maintainers and provide them a front-row seat to serverless innovation.

If you would like to be a maintainer for the Serverless Framework or any of our plugins, please get started with making code contributions and engaging with open issues/PRs. Also, please reach out to any of Serverless organization members to express your interest.

We'd love to collaborate closely with amazing developers as we drive the development of this open technology into the future.

Welcome, and thanks in advance for your help!

How to contribute to Serverless

Setup

Once you've cloned forked repository, all is needed is to run npm install at its root folder

Anatomy of a Framework

Check docs/anatomy.md

When you propose a new feature or bug fix

Please make sure there is an open issue discussing your contribution before jumping into a Pull Request! There are just a few situations (listed below) in which it is fine to submit PR without a corresponding issue:

  • Documentation update
  • Obvious bug fix
  • Maintenance improvement

In all other cases please check if there's an open an issue discussing the given proposal, if there is not, create an issue respecting all its template remarks.

In non-trivial cases please propose and let us review an implementation spec (in the corresponding issue) before jumping into implementation.

Do not submit draft PRs. Submit only finalized work which is ready for merge. If you have any doubts related to implementation work please discuss in the corresponding issue.

Once PR was reviewed and some changes were suggested, please ensure to re-request review after all new changes were pushed. It's the best, noiseless way to inform maintainers that your work is ready to be checked again

When you want to work on an existing issue

Note: Please write a quick comment in the corresponding issue and ask if the feature is still relevant and that you want to jump into the implementation.

Check out our help wanted or good first issue labels to find issues we want to move forward with your help.

We will do our best to respond/review/merge your PR according to priority. We hope that you stay engaged with us during this period to ensure QA. Please note that the PR will be closed if there hasn't been any activity for a long time (~ 30 days) to keep us focused and keep the repo clean.

Reviewing Pull Requests

Another really useful way to contribute to Serverless is to review other people's Pull Requests. Having feedback from multiple people is helpful and reduces the overall time to make a final decision about the Pull Request.

Writing / improving documentation

Our documentation lives on GitHub in the docs directory. Do you see a typo or other ways to improve it? Feel free to edit it and submit a Pull Request!

Providing support

The easiest thing you can do to help us move forward and make an impact on our progress is to simply provide support to other people having difficulties with their Serverless projects.

You can do that by replying to issues on Github, chatting with other community members in our Chat, or helping with questions in our Forum.

Code Style

We aim for a clean, consistent code style. We're using Prettier to confirm one code formatting style and ESlint helps us to stay away from obvious issues that can be picked via static analysis.

Ideally, you should have Prettier and ESlint integrated into your code editor, which will help you not think about specific rules and be sure you submit the code that follows guidelines.

Verifying prettier formatting

npm run prettier-check

Verifying linting style

npm run lint

Other guidelines

  • Minimize lodash usage - resort to it, only if given part of logic cannot be expressed easily with native language constructs
  • When writing asynchronous code, ensure to take advantage of async functions and native Promise API. Do not rely on Bluebird even though still large parts of old code rely on it. We're looking forward to drop this dependency in next months.

Configuring deprecations

Ideally, all breaking changes should be first (before being shipped with next major) communicated with deprecation logs.

Deprecation log can be configured with the following steps:

  1. Write a deprecation log with help of serverless._logDeprecation util.

Log should be written only if deprecated functionality is used. If applicable (to given case) deprecation log should be reported, after service configuration is fully resolved, but before any command logic is run. This can be achieved by attaching to initialize hook (example).

serverless._logDeprecation accepts two arguments:

  • code (e.g. DEPRECATED_FEATURE_NAME). Created to identify log programmatically, also used to construct link on documentation page
  • message Deprecation message to be displayed to the user
  1. Document introduced deprecation at docs/deprecations.md (new deprecation should be listed as first and follow the format of other documented deprecations)

Service configuration validation

All newly introduced configuration properties should be covered by proper changes to configuration schema. For more details about configuration validation, please see docs/configuration-validation.

Testing

See test/README

Our Code of Conduct

Finally, to make sure you have a pleasant experience while being in our welcoming community, please read our code of conduct. It outlines our core values and believes and will make working together with a happier experience.

Thanks again for being a contributor to the Serverless Community 🎉!

Cheers,

The ⚡ Serverless Team