Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add skeleton for contribution guide (contribution section) #708

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CODEOWNERS.in
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
@skitt *
@sridhargaddam *
@tpantelis *
@mkolesnik Makefile /scripts/ /src/content/development/
@mkolesnik Makefile /scripts/ /src/content/contribution/ /src/content/development/
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Contributing

Please see the [Development docs on Submariner's website](https://submariner.io/development/).
For contribution guidelines, please see the [Contribution docs on Submariner's website](https://submariner.io/contribution/).

For development guides, please see the [Development docs on Submariner's website](https://submariner.io/development/).
2 changes: 1 addition & 1 deletion README.md
5 changes: 3 additions & 2 deletions src/content/community/contributor-roles/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ are expected to remain active contributors to the community.
* Contributing to community discussions (e.g. meetings, Slack, email
discussion forums, Stack Overflow)
* Subscribed to [submariner-dev@googlegroups.com]
* Have read the [community] and [development] guides
* Have read the [community], [contribution] and [development] guides
* Actively contributing
* Sponsored by 2 committers. **Note the following requirements for sponsors**:
* Sponsors must have close interactions with the prospective member - e.g.
Expand Down Expand Up @@ -221,9 +221,10 @@ The following apply to people who would be an owner:
* Decide how funds raised by the project are spent.

[parent process]: https://github.com/kubernetes/community/blob/7d2ebad43cde06607cde3d55e9eed4bb08a286a9/community-membership.md
[code reviews]: ../../development/code-review
[code reviews]: ../../contribution/code-review
[community expectations]: https://github.com/kubernetes/community/blob/7d2ebad43cde06607cde3d55e9eed4bb08a286a9/contributors/guide/expectations.md
[development]: ../../development
[contribution]: ../../contribution
[community]: ..
[Submariner org]: https://github.com/submariner-io
[submariner-dev@googlegroups.com]: https://groups.google.com/forum/#!forum/submariner-dev
Expand Down
15 changes: 15 additions & 0 deletions src/content/contribution/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
+++
title = "Contribution"
date = 2020-02-19T20:24:34+01:00
weight = 40
pre = "<b>4. </b>"
+++

* [Guidelines](guidelines)
* [Code Review Guide](code-review)
* [Contributing to the Website](website)
* [Docs Style Guide](website/style-guide)
* [Licenses](licenses)
* [Security](security)
* [Security Reporting](security/reporting)
* [Container Requirements](security/containers)
93 changes: 93 additions & 0 deletions src/content/contribution/guidelines/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Guidelines"
date: 2022-03-15T10:31:00+02:00
weight: 10
---

This guide outlines the process which developers need to follow when contributing to the Submariner project.
Developers are expected to read and follow the guidelines outlined in this guide and in the other contribution guides,
in order for their contributions to the project to be addressed in a timely manner.

## Project Resources

To be expanded

### Backlog Board

To be expanded

### Current Release Board

To be expanded

### Enhancements Repository

To be expanded

### Releases Repository

To be expanded

## Bugs, Tasks and Epics

To be expanded

### Bugs

To be expanded

### Tasks

To be expanded

### Epics

To be expanded

## Release Cycles

To be expanded

### Sprints

To be expanded

### Release Timeline

To be expanded

#### Pre-Planning

To be expanded

#### Feature Design

To be expanded

#### Development Milestones

To be expanded

#### Release Candidates

To be expanded

#### General Availability

To be expanded

### Unplanned Work

To be expanded

#### Ongoing Maintenance

To be expanded

#### Exception Process

To be expanded

### Test Days

To be expanded
11 changes: 2 additions & 9 deletions src/content/development/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
+++
title = "Development"
date = 2020-02-19T20:24:34+01:00
weight = 40
pre = "<b>4. </b>"
weight = 50
pre = "<b>5. </b>"
+++

* [Backports](backports)
* [Building and Testing](building-testing)
* [CI/CD Maintenance](building-testing/ci-maintenance)
* [Code Review Guide](code-review)
* [Contributing to the Website](website)
* [Docs Style Guide](website/style-guide)
* [Licenses](licenses)
* [Release Process](release-process)
* [Security](security)
* [Security Reporting](security/reporting)
* [Container Requirements](security/containers)
* [Working with Shipyard](shipyard)
* [Adding Shipyard to a Project](shipyard/first-time)
* [Advanced Features](shipyard/advanced)
Expand Down
6 changes: 3 additions & 3 deletions src/content/other-resources/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Other Resources"
date: 2020-03-09T20:03:44+01:00
weight: 50
pre: "<b>5. </b>"
weight: 60
pre: "<b>6. </b>"
---

This page catalogs content documenting Submariner elsewhere on the web.
Expand Down Expand Up @@ -65,4 +65,4 @@ This page catalogs content documenting Submariner elsewhere on the web.
* [Kubernetes and the Edge? (2020-10)](https://hal.inria.fr/hal-02972686/document)

If you find additional material that isn't listed here, please feel free to add it to this page by editing it.
The website contributing guide is [here](../development/website).
The website contributing guide is [here](../contribution/website).
2 changes: 1 addition & 1 deletion src/content/security.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Contact: submariner-security@googlegroups.com
Preferred-Languages: en, es, fr
Canonical: https://submariner.io/security.txt
Policy: https://submariner.io/development/security/
Policy: https://submariner.io/contribution/security/
Expires: Thu, 28 Oct 2021 00:00:00 -0000