Skip to content

Commit

Permalink
# Pull Request Template (#2)
Browse files Browse the repository at this point in the history
* Added ROADMAP.md and minor change in CONTRIBUTING.md

* Minor change in CONTRIBUTING.md link

* Changed name of repo
  • Loading branch information
Vishal Saugat committed May 17, 2023
1 parent ab94016 commit 9ea20ca
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ First of all, thank you for your interest in contributing to `k8s-extensions`! W

Here are some basic steps for code contributions:

1. Create a new branch for each feature or bug fix.
2. Write your code. (See below section on creating an extension)
3. Commit your changes. Make sure your commit messages are clear and follow the commit message conventions.
4. Push your changes to your fork.
5. Create a pull request.
6. Address any review comments.
1. Create an issue in the `k8s-extensions` repository on GitHub. Mention clear description stating what is the issue about and if its a new extension or bugfix.
2. Create a new branch for each extension or bug fix.
3. Write your code. (See below section on creating an extension)
4. Commit your changes. Make sure your commit messages are clear and follow the commit message conventions.
5. Push your changes to your fork.
6. Create a pull request.
7. Address any review comments.

> Note: You can take advantage of `templates` folder which contains a boilerplate to get started with building an extension.
>
Expand Down
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Fixes # (issue)
## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I am adhering to the guidelines provided in [CONTRIBUTING.md](CONTRIBUTING.md)
- [ ] I am adhering to the guidelines provided in [CONTRIBUTING.md](https://github.com/Humalect/k8s-extensions/blob/main/CONTRIBUTING.md)
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added corresponding documentation in my extension
Expand Down
3 changes: 3 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Humalect Extensions Roadmap

The Roadmap project board can be found [here](https://github.com/orgs/Humalect/projects/1/views/1). To submit a new extension request. You can open a new PR.

0 comments on commit 9ea20ca

Please sign in to comment.