Skip to content

Commit

Permalink
switched to md for readme & contributions + some clean ups in existin…
Browse files Browse the repository at this point in the history
…g folders
  • Loading branch information
Olivier Jauze authored and Olivier Jauze committed Oct 11, 2024
1 parent fd4fc3d commit ce26bfa
Show file tree
Hide file tree
Showing 17 changed files with 535 additions and 996 deletions.
15 changes: 0 additions & 15 deletions Gemfile

This file was deleted.

40 changes: 0 additions & 40 deletions build-docs.sh

This file was deleted.

18 changes: 0 additions & 18 deletions build.sh

This file was deleted.

15 changes: 0 additions & 15 deletions communication/CafMessages-old.adoc

This file was deleted.

15 changes: 0 additions & 15 deletions communication/CafMessages.adoc

This file was deleted.

Binary file removed communication/CafMessages.mp3
Binary file not shown.
43 changes: 0 additions & 43 deletions communication/marketing-plan.md

This file was deleted.

29 changes: 2 additions & 27 deletions governance/contributing.adoc → governance/contributing.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,13 @@
= Contributing to Continuous Architecture toolkit
// Metadata:
:description: Toolkit Elaboration Guide
:keywords: guide
:main-title: Continuous Architecture Toolkit
// Settings:
:icons: font
:idprefix:
:idseparator: -
:preface-title:
:numbered!:
:sectlinks:
:sectanchors:
:stylesdir: ./css
:scriptsdir: ./js
:imagesdir: ./img
// GitHub admonitions:
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: pass:[ℹ]
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]

Thanks for your interest in contributing! This document outlines how we expect contributions to happen.

WARNING: Note that contributions can only be made by individuals representing themselves, not by a company.

1. Start by searching the https://github.com/michelin/Continuous-Architecture-Toolkit/issues[issue tracker] to see if your contribution, be it a problem or a suggestion for an enhancement, was brought up before.
1. Start by searching the [issue tracker](https://github.com/michelin/Continuous-Architecture-Toolkit/issues) to see if your contribution, be it a problem or a suggestion for an enhancement, was brought up before.
2. If nothing satisfying comes up, feel free to file a new issue. Provide as many details about your idea, problem, or suggestion as possible.
3. Once a conversation with one or more maintainers has taken place, it should become clear when it is appropriate to suggest a change via a pull request.
4. Fork the project repository and add materials on a topic of your choice. Then submit a pull request outlining your changes so maintainers can review what you've added and work with you to polish it.
5. Alternatively, propose edits to some assets directly in your browser. Select a file in the project repository by clicking on it. Locate and click the pencil icon at the top of every file in the repository. Make chages to the file in your browser, then submit that file for review.

== Getting Involved

search our https://github.com/michelin/Continuous-Architecture-Toolkit/issues[issue tracker] for issues with the "help wanted" label
search our [issue tracker](https://github.com/michelin/Continuous-Architecture-Toolkit/issues) for issues with the "help wanted" label
72 changes: 15 additions & 57 deletions governance/governance.adoc → governance/governance.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,7 @@
= Governance
// Metadata:
:description: Governance
:keywords: guide
:main-title: Continuous Architecture Toolkit
// Settings:
:icons:
:idprefix:
:idseparator: -
:preface-title:
:toc2:
:toc:
:toclevels: 3
:numbered:
:sectlinks:
:sectanchors:
:experimental:
:imagesdir: ./img
:stylesdir: ./styles
:scriptsdir: ./js
// GitHub admonitions:
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: pass:[ℹ]
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]

The objective of this document is to describe the process of decision
making and defines the social rules of interaction for our project.

== Community
# Community

If you'd like to speak to maintainers of this project, you can reach us
through a bunch of different channels.
Expand All @@ -39,7 +10,7 @@ through a bunch of different channels.
by using the @github/Continuous-Architecture-Toolkit handle.
* *Slack* We're pretty active on slack.

== Roles and Responsibilities
## Roles and Responsibilities

* *Users* are community members who have a need for Continuous Architecture Toolkit. They are the most important members of the community and without them the project would have no purpose. Anyone can be a user; there are no special requirements. We asks users to participate in community and give us as much feedback as they can. User contributions enable the project team to ensure that they are satisfying the needs of those users. +
See link:contributing.adoc[Contributor guide] for more details.
Expand All @@ -48,12 +19,10 @@ See link:contributing.adoc[Contributor guide] for more details.
* *Maintainers* are people responsible over the direction of the project and are committed to improving it in the long run. There are the only people in a project with commit access.
See link:maintainer-guide.adoc[Maintainer guide] for more details.

== Decision-Making process
## Decision-Making process

The default decision making mechanism for the Continuous Architecture
Toolkit project is
http://www.apache.org/foundation/how-it-works.html#decision-making[lazy
consensus]. This means that any decision on issues is considered
The default decision making mechanism for the Continuous Architecture Toolkit project is [lazy
consensus](http://www.apache.org/foundation/how-it-works.html#decision-making). This means that any decision on issues is considered
supported by the core team as long as nobody objects.

Silence on any consensus decision is implicit agreement and equivalent
Expand All @@ -63,16 +32,14 @@ If any team member raises objections, the team members work together
towards a solution that all involved can accept. This solution is again
subject to lazy consensus.

=== Commit Policy
### Commit Policy

To approve change proposals from contributors, Continuous Architecture
Toolkit projet apply the Review-Then-Commit policy which requires that
all pull-request changes receive
http://www.apache.org/foundation/how-it-works.html#decision-making[lazy
consensus] approval by maintainers, meaning at least one binding +1 vote
To approve change proposals from contributors, Continuous Architecture Toolkit projet apply the Review-Then-Commit policy which requires that
all pull-request changes receive [lazy
consensus](http://www.apache.org/foundation/how-it-works.html#decision-making) approval by maintainers, meaning at least one binding +1 vote
and no vetos (-1) in order to be committed.

=== Governance Committee
### Governance Committee

For other matters that need consensus like:

Expand All @@ -97,20 +64,11 @@ organized as required and conducted using a video call. Participation is
open to all maintainers. Agenda items can be added by any maintainers by
simply adding topics to the Governance Meeting Agenda.

Decisions are taken with a
http://www.apache.org/foundation/how-it-works.html#decision-making[lazy
consensus approach] except nominated maintainers membership.
Decisions are taken with a [lazy
consensus approach](http://www.apache.org/foundation/how-it-works.html#decision-making) except nominated maintainers membership.

=== Maintainer member status
### Maintainer member status

Maintainer member status may be given to those who have made major
ongoing contributions to the Continuous Architecture toolkit for at
least 3 months. This is usually in the form of assets improvements
and/or notable work on documentation, but organizing events or community
support could also be taken into account.
Maintainer member status may be given to those who have made major ongoing contributions to the Continuous Architecture toolkit for at least 3 months. This is usually in the form of assets improvements and/or notable work on documentation, but organizing events or community support could also be taken into account.

New members may be proposed by any existing maitainers. It is highly
desirable to reach consensus about acceptance of a new member. However,
the proposal is ultimately voted on by a formal majority vote (requires
more binding +1 votes than binding -1 votes) during Governance
Committee.
New members may be proposed by any existing maitainers. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal majority vote (requires more binding +1 votes than binding -1 votes) during Governance Committee.
Loading

0 comments on commit ce26bfa

Please sign in to comment.