Skip to content

Commit af1f65d

Browse files
committed
add basic contribution guide
1 parent 5464c89 commit af1f65d

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Awesome Akash [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
22

3-
This is an awesome source of resources, ready-to-deploy templates, and other information that can help you get started on Akash. To add to this list or to suggest modifications, please look at our [contribution guide]().
3+
This is an awesome source of resources, ready-to-deploy templates, and other information that can help you get started on Akash. To add to this list or to suggest modifications, please look at our [contribution guide](./contributing.md).
44

55
Akash is a digital marketplace where users can rent computing resources to host services. It runs on a decentralized P2P network and functions using the Akash token and is developed and run by the community.
66

contributing.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Contribution Guidelines
2+
3+
If you have an awesome template or resource that you want to share with other people on this list, you are welcome to propose changes to the list.
4+
5+
Note: for all PRs, please either run `[awesome-lint](https://github.com/sindresorhus/awesome-lint)` before submitting a PR or work closely with the automatic lint logs given on PRs to ensure proper formatting if you're not sure.
6+
7+
## Adding a template
8+
9+
Requirements for adding a template:
10+
11+
- Typically an entry can be added below another one in the same category as a new line with this content: `- [Template Name](https://github.com/username/repository/deploy.yml) - Description of the template.` when pointing to your own repository or `- [Template Name](./templates/template_name/deploy.yml) - Description of the template.` when having added the template to the templates folder.
12+
- Make sure that your spelling and grammar for the description is correct, that the casing is as shown in the other list items, and that the description ends with a dot.

0 commit comments

Comments
 (0)