forked from AcademySoftwareFoundation/xstudio
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request AcademySoftwareFoundation#118 from tedwaine/main
Adding community standards information.
- Loading branch information
Showing
3 changed files
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Committers | ||
|
||
This is a list of commiters for the xSTUDIO project, sorted alphabetically by first name. | ||
|
||
* Al Crate ([alatdneg](https://github.com/alatdneg)) | ||
* Ted Waine ([tedwaine](https://github.com/tedwaine)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Contributing | ||
|
||
Thank you for your interest in contributing to xSTDUIO. We warmly encourage all contributions and the managers of this repository will do their best to assist you with any questions as well as act as effective reviewers and approvers. | ||
|
||
## Project Roles and Responsibilities | ||
|
||
Please read this document to learn how to contribute to xSTUDIO. | ||
|
||
Start by getting familiar with the [GOVERNANCE](GOVERNANCE.md) document. It details the rules and responsibilities for Contributors, Committers, and Technical Steering Committee members. | ||
|
||
## Committers | ||
|
||
The xSTUDIO Project Committers are listed in alphabetical order, by first name, in [COMMITERS](COMMITERS.md) | ||
|
||
## Contributor License Agreement | ||
|
||
Before contributing code to xSTUDIO source code, you must sign a Contributor License Agreement (CLA). | ||
|
||
You will get the opportunity to sign the CLA when you create your first pull request: the Linux Foundation's EasyCLA system will guide you through the process of signing the CLA. | ||
|
||
Here are the two possible CLAs: | ||
|
||
There are two contribution agreement types, one for individuals contributing independently, and one for corporations who want to manage a list of contributors for their organization. Please review the documents in the EasyCLA portal to determine which is the right one for you. | ||
|
||
## Coding Conventions | ||
|
||
Please follow the coding style accross the various file types in the project as best you can. While we have strived to maintain a consistent formatting to the code you may find there are differing styles thanks to the various authors and their natural preferences. We suggest you do your best to follow what's already there but we will not impose a strict style on new code in PRs. We do periodically run clang auto formatting across the C++ components of the codebase. Clang formatting rules are defined in the .clang-tidy and .clang-format files in the root. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
|
||
# xSTUDIO Project Governance | ||
|
||
The xSTUDIO project is governed by its Committers in collaboration with the Open Review Initiative (ORI) Steering Committee (TSC). | ||
|
||
xSTUDIO is a relatively new project and is still under very active development as we approach a version 1.0 release. An xSTUDIO TSC will be formed whern the project has reached both a level of stability and community engagement which demands such governance. Until then discussions about the direction of the project will be held in the ORI Community Meetings or with direct interaction with the current [COMMITERS](COMMITERS.md). | ||
|
||
## Contributors | ||
|
||
Contributors include anyone in the community that contributes code, documentation, or other technical artifacts that have been incorporated into the project's repository. | ||
|
||
## Committers | ||
|
||
The xSTUDIO GitHub repository is maintained by the [COMMITERS](COMMITERS.md). Committers are Contributors who have earned the ability to modify source code, documentation, or other technical artifacts to the project. Upon becoming Committers, they become members of the xSTUDIO leadership team. | ||
|
||
Their privileges include, but are not limited to: | ||
|
||
* Commit access to the xSTUDIO repository | ||
* Moderator status on all communication channels | ||
|
||
### Committer Activities | ||
|
||
Typical activities of a Committer include: | ||
|
||
* Helping users and novice contributors | ||
* Contributing code and documentation changes that improve the project | ||
* Reviewing and commenting on issues and pull requests | ||
* Participation in Open Review Initiative community meetings | ||
* Merging pull requests | ||
|
||
The xSTDUIO TSC, when it has been formed, will periodically review the Committer list to identify inactive Committers. Past Committers are typically given Emeritus status. Emeriti may request that the TSC restore them to active Committer status. | ||
|
||
## Technical Steering Committee | ||
|
||
A description of the xSTUDIO TSC, its members, their roles and how the TSC will govern the xSTUDIO project will be provided when the TSC is formed. |