## 1. Project Overview & Quickstart (GradleUp/LICENSE)

# LICENSE

Open-source repository GradleUp/LICENSE

### Repository Details
- **Repository:** [GradleUp/LICENSE](https://github.com/GradleUp/LICENSE)
- **Primary Language:** Code

*Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.*

## 2. Official Technical Reference & Guides (GradleUp/GradleUp.github.io)

## File: README.md

[](https://gradleup.com/)
[](https://gradleup.com/projects/)
[](https://gradleup.com/docs/community/participate/#slack)
[](https://gradleup.com/docs/community/participate/)

This repository hosts a [GradleUp website](https://gradleup.com/).
It includes the styles and some top-level content.
Project documentation and other information are sourced from other repositories.

## What is GradleUp?

GradleUp is an umbrella [GitHub organization](https://github.com/gradleup) created by, and for, the community.
GradleUp focuses on simplifying building Java, Kotlin and Android projects.
On our menu: Gradle plugins, developer tools and best practices.

**GradleUp is not affiliated with, or sponsored by Gradle, Inc. Gradle Up is an independent organization and its projects, plugins, and products are not affiliated with or sponsored by Gradle, Inc. in any way.**

## License

<a property="dct:title" rel="cc:attributionURL" href="https://gradleup.com">This site</a> by the <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/GradleUp">GradleUp team and contributors</a> is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1)

Imported content from external repositories might have other licenses.

## Contributing

Any contributions, typo fixes and patches are welcome!
The content is located inside the project repositories.
If you want to contribute to the GradleUp site,
see the guidelines [here](./CONTRIBUTING.md)

---

## File: docs/community/governance.md

# GradleUp Governance Charter

## What is GradleUp?

GradleUp is a volunteer-driven umbrella GitHub organization
focusing on simplifying developer experience with [Gradle Build Tool (a.k.a. Gradle)](https://gradle.org/),
in particular for Java, Kotlin and Android projects.
We host components and ensure their long-term sustainability.

Our scope includes all things that help to achieve great user and developer experience when working with Gradle.
It includes but not limited to plugins, developer tools, integrations, documentation or community content.

## Formal Side

The GradleUp organization is a volunteer driven community
operating in a public interest in a non-profit mode and
providing no commercial services.
There is no formal legal entity behind GradleUp.
As it is written in the Apache License v2:

> Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

Gradle and the Gradlephant logo (the "Gradle Marks") are registered trademarks of [Gradle, Inc.](https://gradle.com/) and/or its subsidiaries.
In the GradleUp organization, "Gradle" typically means "Gradle Build Tool" and does not reference Gradle Inc. and/or its subsidiaries.
All references to the trademark represent a fair use,
and do not imply endorsement.

## Structure

The project is led by a small team of passionate Gradle users and contributors.
This [GradleUp Team](./team.md) is to be considered as a top governance and steering entity for the project.

The project also includes maintainers and contributors.

## Roles

* **Contributor** - any individual who participates in the community and 
  adds value to in one form or another,
  including but not limited to code, documentation, automation, advocacy or
  community support.
* **Team Member** -
  A GradleUp contributor listed on the [GradleUp Team page](./team.md).
  They participate in the project steering as whole.
  New team members are added by the decision of the current team members.
* **Org Admin** - A team member with administrative access to the GitHub
  organization and/or other community resources.
  Permissions and access are granted based on the decision of the current team members.
* **Maintainer** - A GradleUp contributor who maintains a component hosted on GradleUp.
  It includes roles _Triage_ or above.
  Components may explicitly or implicitly introduce more Maintainer sub-roles.
  
## Decision Making

The decisions are made by the [GradleUp Team](./team.md) based on consensus and common sense.
We intend to make decision making fast and light-weight,
with minimum overhead when a consensus exists.

Most of the decisions are discussed and made in
[public communication channels](./participate.md).
It is expected that all contributors and end users are able to participate to the decisions.
Some exceptional decisions,
for example Code of Conduct discussions,
may be done in private.

## Components Governance

### Component Ownership

_Maintainers_ have full control of technical decisions and processes within their components.
Apart from the requirements documented in the [Hosting Guidelines](./hosting.md),
_Maintainers_ are free to define the governance processes within their repositories,
to add collaborators to the projects,
or to implement automation and release process as they deem beneficial.

All hosted components remain a subject to [GradleUp Code of Conduct](../../org/CODE_OF_CONDUCT.md),
and they must adhere to some security and hosting rules documented in the [Hosting Guidelines](./hosting.md).
The recommendations and best practices remain optional.

### Hosting New Components

New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.
See the [Hosting New Projects page](./hosting.md) for more information.

### Transferring Ownership

Should a _Maintainer_ explicitly move-on and put a project for adoption,
or become unresponsive for a long period of time,
the _GradleUp Team_ can re-assign ownership of the project to ensure the
continuity of the component.
A best possible effort should be made to reach out to the maintainer beforehand.

## Open Source Commitment

In GradleUp, we are committed to open source.
We intend to do most of the work in public,
and to have publicly open communication channels to discuss the changes and the strategy.

We reserve the right to do some work in private when it is required to
ensure confidentiality and safety of GradleUp contributors and users.
Possible examples include:

* Vulnerability reporting, security patches and advisory preparetion.
  See the [Security Policy](../../org/SECURITY.md)
* Code of Conduct escalations, investigation and follow-ups
* Distribution of physical assets like swag

## Licenses

Within our resources we host **ONLY** open source components
under the [OSI-compliant licenses](https://opensource.org/licenses).

The non-code components under the <a property="dct:title" rel="cc:attributionURL" href="https://github.com/GradleUp">GradleUp organization on GitHub</a> and created by the <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/GradleUp">GradleUp team and contributors</a>, unless explicitly specificed otherwise, are licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/?ref=chooser-v1)

## Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
Read our full [Code of Conduct](../../org/CODE_OF_CONDUCT.md).

---

## File: docs/community/hosting.md

# Hosting New Projects on GradleUp

New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.

## Hosting Process

At the moment, there is no documented process for hosting new components.
The criteria below are general practices,
and they will be extended over time.
The decision will be made by the [GradleUp Team](./team.md) on a case by case basis.

To request the transfer and initiate the discussion, contact the team.

## Criteria

The general criteria for hosting a project are:

- The project has value to the ecosystem and fits into the GradleUp scope.
- The project must be open source and licensed under one of the
  [OSI-approved open source licenses](https://opensource.org/).
- The project follows the best practices for creating Gradle plugins and components.
- The requesting contributors are willing to continue maintenance of the project
  after the transfer.
- The requesting contributors are willing to ensure sustainability of their project,
  and fine with it being transferred to another maintainer should they become inactive as documented in the [Governance Charter](./governance.md).

---

## File: docs/community/participate.md

---
title: Participate in GradleUp
    Subscribe to the GradleUp news,
    join the discussions on Slack and GitHub issues 
---

[](./#slack)

Subscribe to the GradleUp news, join the discussions on Slack and GitHub issues.
All code and non-code contributions are welcome!

## News

We have a blog on [blog.gradleup.com](https://blog.gradleup.com/).
There we will be publishing the key updates on what's up in GradleUp.
You can also subscribe to the blog as a [newsletter](https://blog.gradleup.com/newsletter)
or [RSS feed](https://blog.gradleup.com/rss.xml).

Guest posts by GradleUp users and component maintainers are welcome, too!
Reach out to us on Slack if interested

## GitHub Issues

Each project repository has GitHub Issues enabled.
Please raise bugs and discuss feature requests there.

## Slack

We have a `#gradleup` public channel on the
[Gradle Community Slack](https://community.gradle.org/contributing/community-slack/).
This chat is used for real-time development and end user discussions.
For longer-term discussions, e.g. architecture proposals or feature requests,
it is highly recommended to use GitHub Issues in the respective repositories.

The following components have custom channels:

- `#dev-shadow-plugin` - development of the Shadow Plugin.

In the future, we may introduce more channels.

## Slack Archive

Gradle Community Slack uses the free plan,
so the history of `#gradleup` is limited to 3 months.
You can find the communications archive for previous dates
[here](https://www.linen.dev/s/gradle-community/c/gradleup).

---

## File: docs/community/team.md

# GradleUp Team

The project is led by a small team of passionate Gradle users and contributors.
The team is decentralized and decisions are made based on consensus and common sense.
Learn more in the [Governance Document](./governance.md).

## Members

- [Alex Nordlund (@deepy)](https://github.com/deepy)
- [Jean-Michel Fayard (@jmfayard)](https://github.com/jmfayard)
- [Louis CAD (@LouisCAD)](https://github.com/LouisCAD)
- [Martin Bonnin (@martinbonnin)](https://github.com/martinbonnin)
- [Pablisco (@pablisco)](https://github.com/pablisco)
- [Said Tahsin Dane (@tasomaniac)](https://github.com/tasomaniac)
- [Nicola Corti (@cortinico)](https://github.com/cortinico)

## Contact the Team

For now, we use DMs on the Kotlinlang Slack, or the Gradle Community Slack.
Public communication channels are to be established soon.

---

## File: projects/README.md

# GradleUp Projects

The key projects are listed below.
You can find the full list of projects being developed by the team
on the [GitHub organization](https://github.com/GradleUp)

## Gradle Plugins

- [Tapmoc](../tapmoc/) -
  Makes it easy to handle your Java & Kotlin compatibility flags
- [Auto Manifest](../auto-manifest/README.md) -
  Generates `AndroidManifest.xml` in simple libraries so that you don't have to
- [Gradle static analysis plugin](../static-analysis-plugin/README.md) -
  A Gradle plugin to easily apply the same setup of static analysis tools
  across different Android, Java or Kotlin projects.
- [Gratatouille](../gratatouille/README.md) -
  Gratatouille is an opinionated framework to build Gradle plugins. Write pure Kotlin functions and the Gratatouille KSP processor generates tasks, workers and wiring code for you.
- [Gr8](../gr8/README.md) -
  Gr8 makes it easy to shadow, shrink, and minimize your jars.
- [Librarian](../librarian/README.md) -
  Librarian is a library to help building Kotlin libraries.
- [Maven Sympathy](../maven-sympathy/README.md) -
  A small Gradle plugin that checks that your project dependencies play nice with Maven resolution strategy
- [NMCP](../nmcp/README.md) (New Maven Central Publishing) -
  A plugin that uses the new Central Portal publisher API to publish to Maven Central.
- [Shadow](../shadow/README.md) -
  Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries.
  Gradle version of Maven's Shade plugin.

## Hosting New Projects

New Gradle related projects can be potentially hosted on GradleUp.
It includes transferring the project to GradleUp,
and ensuring quality and sustainability of the project.
See the [New Projects Hosting Guide](../docs/community/hosting.md) for more info.