Skip to content

Latest commit

 

History

History
22 lines (14 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

22 lines (14 loc) · 2 KB
Raw

Contributing

We would really love for you to contribute in any way to SLIC Starter!

When contributing to this repository, it would be great if you could first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Note that we have a code of conduct. Please follow it in all your interactions with the project.

Where to Contribute

There are a number of areas where you can contribute right now.

  1. The number one way to contribute right now is by using SLIC Starter to bootstrap a serverless project, deploying it and sharing your experience so we can improve it. We know there is plenty of scope to make the experience better but we want your guidance! How can we make it easier to configure and clearer to understand what's going on? What kind of documentation would make it better for you? Let us know in the Issues.
  2. We label some open issues with the "help wanted" label. You can see them here. Let us know in the issue if you are planning to work on ths issue so we can share ideas and to make sure we have the same understanding of the scope.
  3. Sometimes we will label issues as "good first issue". If you are new to open source or just to some of the areas this project covers, these issues are a great way to get started. The list is here.

Pull Request Process

  1. Ensure that all test have been run and pass.
  2. This project uses conventional commits. Ensure that your commits follows the guidelines.
  3. Update the README.md with details of changes and documentation.
  4. You may merge the Pull Request in once you have the sign-off of another contributor or if you do not have permission to do that, you may request the second reviewer to merge it for you.