docs: drafted CONTRIBUTING.md

This commit is contained in:
Corentin Thomasset 2021-03-15 13:20:37 +01:00
parent 5e9c8bd781
commit 991f9f8e1e
No known key found for this signature in database
GPG key ID: DBD997E935996158

45
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,45 @@
# Contributing
## Commit message semantic
// TODO
## Create a tool
Create a `.vue` file in `pages/tools/[category]/[route].vue` where `[category]` correspond to the tool scope and
`[route]` will be the path of the file in the url (ex: `foo-bar.vue` will be accessible at it-tools.tech/foo-bar).
Here is a template of a component
```vue
<template>
<ToolWrapper :config="config()">
Hello world
</ToolWrapper>
</template>
<script lang="ts">
import {Component} from 'nuxt-property-decorator'
import type {ToolConfig} from '@/types/ToolConfig'
import Tool from '~/components/Tool.vue'
@Component
export default class UuidGenerator extends Tool {
config(): ToolConfig {
return {
title: 'My component',
description: 'The description of my component',
icon: 'mdi-icon',
keywords: ['some', 'keywords', 'here']
}
}
}
</script>
<style scoped lang="less">
// Extra styling here
</style>
```