Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* combine contributing docs * point new release notes to releases Co-authored-by: Shereef Marzouk <shereef.marzouk@daysmart.com>
- Loading branch information
1 parent
bbb0844
commit cec06df
Showing
3 changed files
with
60 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,34 @@ | ||
# Contribution guide | ||
|
||
When contributing to this repository, please first open an issue so that the community of contributors to this repository can discuss the suggestion before a change is made. | ||
|
||
Commits follow the [Angular commit convention](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). | ||
|
||
Run `npx cz` to commit with prompts to help you write a commit message. | ||
|
||
## Pull Request Process | ||
|
||
Once you have finished making your changes: | ||
|
||
1. Make sure that your code satisfies the standards laid out in the [testing](#testing) and [coding style](#coding-style) section of this document. | ||
2. Update README.md with details on any changes to the interface or behavior of the plugin. | ||
3. Submit your PR, using the PR template provided to describe the details of your changes. | ||
|
||
Then, | ||
|
||
4. For substantial changes to the plugin, we will try to get at least two community sign-offs and some discussion of the PR before merging. | ||
- For non-controversial or minor PRs (e.g. phrasing updates in the documentation, minor refactoring of constants), one approval will be sufficient to move forward. | ||
5. A contributor with push access to the repo will merge the PR after all tests and fixes have occured. | ||
6. A new release will be published (if appropriate). | ||
|
||
### Testing | ||
|
||
Please read our [testing guide](./test/README.md) and ensure any changes are covered by unit tests, and integration tests if applicable. | ||
|
||
### Coding Style | ||
|
||
This repository uses [prettier](https://prettier.io/) to enforce a uniform coding style. You may install an editor plugin for prettier, but code will also be auto-formatted via a git hook whenever you commit code. | ||
|
||
### Code of Conduct | ||
|
||
Please be polite and respectful in all your communication and actions towards others in the serverless-finch community. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.