Skip to content

Commit ef307a8

Browse files
authored
chore: add README.md and CONTRIBUTING.md (#58)
1 parent 38b63b6 commit ef307a8

File tree

3 files changed

+104
-1
lines changed

3 files changed

+104
-1
lines changed

.github/CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# How to contribute
2+
3+
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [developer.tapio.one](https://developer.tapio.one) ✨.
4+
5+
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
6+
7+
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
8+
9+
## New contributor guide
10+
11+
To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
12+
13+
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
14+
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
15+
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
16+
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
17+
18+
## Issues
19+
20+
### Create a new issue
21+
22+
If you spot a problem with the docs, [search if an issue already exists](https://github.com/tapioone/docs/issues). If a related issue doesn't exist, you can open a new issue.
23+
24+
### Solve an issue
25+
26+
Scan through our [existing issues](https://github.com/tapioone/docs/issues) to find one that interests you. If you find an issue to work on, you are welcome to open a PR with a fix!
27+
28+
#### Make Changes
29+
30+
1. Install the correct node version (see `package.json`).
31+
2. Clone the repository `git clone https://github.com/tapioone/docs.git`.
32+
3. Install all dependencies `npm install`.
33+
4. Start the development server `npm run start`.
34+
5. Make your changes.
35+
36+
#### Commit your update
37+
38+
Commit the changes once you are happy with them. Please adhere to the [conventional commits standard](https://www.conventionalcommits.org/en/v1.0.0/) for naming your commits.
39+
40+
#### Pull Request
41+
42+
When you're finished with the changes, create a pull request, also known as a PR.
43+
44+
- Don't forget to [link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
45+
- Once you submit your PR, a friendly bot will kindly ask you to sign our [CLA](https://github.com/tapioone/cla).
46+
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
47+
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
48+
- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.

.github/SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
The tapio team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings!
66

7-
To report a security issue, **DO NOT** open a GitHub issue, but send us an email to [info@tapio.one](mailto:info@tapio.one?subject=SECURITY) including the word `SECURITY` in the subject line.
7+
To report a security issue, **DO NOT** open a GitHub issue, but send us an email to [developer@tapio.one](mailto:developer@tapio.one?subject=SECURITY) including the word `SECURITY` in the subject line.
88

99
The tapio team will send a response indicating the next steps in handling your report. After the initial reply to your report, the team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<div align=center>
2+
3+
<h1>tapio docs</h1>
4+
5+
</div>
6+
7+
This repository contains the documentation website code and Markdown source files for [developer.tapio.one](https://developer.tapio.one).
8+
9+
tapio is the digital ecosystem for the woodworking industry. It enables both small carpenters and industrial furniture productions to digitalize their production in a short period of time. It even allows third party developers to implement new solutions, based on the data of tapio-connected machines.
10+
11+
## Run Locally
12+
13+
Clone the project
14+
15+
```bash
16+
git clone https://github.com/tapioone/docs.git
17+
```
18+
19+
Go to the project directory
20+
21+
```bash
22+
cd docs
23+
```
24+
25+
Install dependencies
26+
27+
```bash
28+
npm install
29+
```
30+
31+
Start the server
32+
33+
```bash
34+
npm run start
35+
```
36+
37+
## Contributing
38+
39+
Contributions are always welcome!
40+
41+
See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for ways to get started.
42+
43+
Please adhere to our [code of conduct](./.github/CODE_OF_CONDUCT.md).
44+
45+
## Feedback
46+
47+
If you have any feedback, please reach out to us at [email protected]
48+
49+
## Security
50+
51+
The tapio team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings! Please refer to our [security policy](./.github/SECURITY.md).
52+
53+
## License
54+
55+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)