Skip to content

Commit

Permalink
(feat): add developer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Callisto13 committed Nov 8, 2021
1 parent ac00c58 commit c319f95
Show file tree
Hide file tree
Showing 7 changed files with 642 additions and 47 deletions.
13 changes: 12 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ labels: kind/bug
assignees: ''
---

<!--
In order to help us process this issue faster, please provide as much detail as possible.
Before creating a new request for help, please search existing issue to see if you find a similar one.
If there is a similar feature request please up-vote it and/or add your comments to it instead
For more information on how to request help on flintlock, please refer to our community docs.
https://github.com/weaveworks/flintlock/blob/main/CONTRIBUTING.md#opening-issues
-->

**What happened:**
[A clear and concise description of what the bug is.]

Expand All @@ -23,4 +33,5 @@ assignees: ''
**Environment:**

- flintlock version:
- OS (e.g. from `/etc/os-release`):
- containerd version:
- OS (e.g. from `/etc/os-release`):
12 changes: 11 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ labels: kind/feature
assigness: ''
---

<!--
In order to help us process this issue faster, please provide as much detail as possible.
Before creating a new request for help, please search existing issue to see if you find a similar one.
If there is a similar feature request please up-vote it and/or add your comments to it instead
For more information on how to request help on flintlock, please refer to our community docs.
https://github.com/weaveworks/flintlock/blob/main/CONTRIBUTING.md#opening-issues
-->

**Describe the solution you'd like:**
[A clear and concise description of what you want to happen.]

**Why do you want this feature:**

**Anything else you would like to add:**
[Miscellaneous information that will assist in solving the issue.]
[Miscellaneous information that will assist in solving the issue.]
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/request_for_help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Request for help
about: Do you need help with flintlock?
title: ''
labels: kind/help
assignees: ''

---

<!--
In order to help us process this issue faster, please provide as much detail as possible.
Before creating a new request for help, please search existing issue to see if you find a similar one.
If there is a similar feature request please up-vote it and/or add your comments to it instead
For more information on how to request help on flintlock, please refer to our community docs.
https://github.com/weaveworks/flintlock/blob/main/CONTRIBUTING.md#opening-issues
-->

**What help do you need?**
<!--
Explain what you are trying to accomplish, what you have tried, and the behaviour you are seeing.
When providing any output or code/config samples, please use code blocks.
When providing verbose logs, please use either a gist or html detail tags.
-->
50 changes: 50 additions & 0 deletions COMMUNITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Flintlock community

Welcome to the flintlock community. We are very happy to have you here :tada: .

This document contains the following information:

- [Who the core team members are](#core-team)
- [How to join the community](#join-us) and get in touch with the core team
- [How flintlock is run](#how-flintlock-is-run) and how decisions are made
- [Community meetings](#community-meetings)
- [Community rules](#community-rules)

Ready to start contributing? Head over to our [contribution docs](CONTRIBUTING.md) :man_technologist:.

## Core team

TODO

## Join us!

The project uses Slack. If you get stuck or just have a question then you are encouraged to join the
[Weave Community](https://slack.weave.works/) Slack workspace and use the
[#flintlock](https://weave-community.slack.com/messages/flintlock/) channel.

## How Flintlock is run

Flintlock is an open-source project built to

etc

We welcome all contributions and user feedback to the project.

**The roles in the flintlock community are as follows:**
- End users. In other words the reason why we are all here!
- Community contributors. These could be end users themselves, or those working
on their open-source game.
- Maintainers.

Decisions are made by Maintainers with input from both Weaveworks and the community.
All the decisions which can be made publicly will take into account the opinions
of all in the community with sufficient opportunity given for those interested
to get involved.

## Community meetings

TODO

## Community rules

The main one is **Always be kind**, and the rest can be found in our [Code of Conduct](CODE_OF_CONDUCT.md).
Loading

0 comments on commit c319f95

Please sign in to comment.