Skip to content

Latest commit

 

History

History
138 lines (87 loc) · 5.37 KB

CONTRIBUTING.md

File metadata and controls

138 lines (87 loc) · 5.37 KB
Raw

Contributing Guidelines

Welcome, and thanks in advance for your help! Please follow these simple guidelines 👍

How to contribute to the Serverless Azure Plugin

When you propose a new feature or bug fix

Note: Please make sure to write an issue first and get enough feedback before jumping into a Pull Request!

  • Please make sure there is an open issue discussing your contribution
  • If there isn't, please open an issue so we can talk about it before you invest time into the implementation
  • When creating an issue or pull request, follow the template that GitHub shows so that we have enough information about your request

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.

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 insure 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 peoples Pull Requests. Having feedback from multiple people is really 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.

Commit Message Format

Each commit message consists of a header, a body and a footer.

<type>: <short description>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Header

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies
  • ci: Changes to our CI configuration files and scripts
  • docs: Documentation only changes
  • feat: A new feature (triggers a minor release)
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests
  • chore: Updating dependencies
  • major: Breaking change - merge to master will trigger a major release
  • beta: Beta feature - merge to master will trigger a pre-release to NPM

All commit messages that do not have a specified release above will trigger a patch release.

Short Description

Contains a succinct description of the change:

  • use the imperative, present tense: "change" not "changed" nor "changes"
  • don't capitalize the first letter
  • no dot (.) at the end

Body

Just as in the short description, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.

Footer

The footer should contain any information about breaking changes and is also the place to reference Azure DevOps user stories/tasks or GitHub issues that this commit closes.

Commit Message Example

fix: add debouncing to asset scroller to correct browser scroll position

There is no debouncing when we store the asset container's scroll position.
This results in erratic, jumpy scrolling and a poor user experience. Improve
stability and usability with debouncing.

closes #123

Code Style

We aim for clean, consistent code style. We're using ESlint to check for codestyle issues.

Verifying linting style

npm run lint

Fixing lint issues

npm run lint:fix

To help reduce the effort of creating contributions with this style, an .editorconfig file is provided that your editor may use to override any conflicting global defaults and automate a subset of the style settings.

Testing

We aim for a (near) 75% test coverage, so make sure your tests cover as much of your code as possible.

Test coverage

During development, you can easily check coverage by running npm test.

Please follow these Testing guidelines when writing your unit tests:

  • Include a top-level describe('ClassName') block, with the name of the class you are testing
  • Inside that top-level describe() block, create another describe('#methodOne()') block for each class method you might create or modify
  • For each method, include an it('should do something') test case for each logical edge case in your changes
  • As you write tests, check the code coverage and make sure all lines of code are covered. If not, just add more test cases until everything is covered
  • For reference and inspiration, please check our tests directory

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

Thanks!