Skip to content

Commit f25105a

Browse files
author
John Plaisted
authored
Spotless (#3)
Apply spotless to markdown and enforce via github flow. imo a lot of the markdown was very hard to read (in markdown, rendered was fine / is the same). This spotless plugin helps to enforce a format. Also remove old workflow files.
1 parent 6ece5c8 commit f25105a

38 files changed

+939
-554
lines changed

.github/ISSUE_TEMPLATE/--bug-report.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,32 @@ name: "\U0001F41EBug report"
33
about: Create a report to help us improve
44
title: A short description of the bug
55
labels: bug
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

10-
**Describe the bug**
11-
A clear and concise description of what the bug is.
9+
#### Describe the bug A clear and concise description of what the bug is.
10+
11+
#### To Reproduce
1212

13-
**To Reproduce**
1413
Steps to reproduce the behavior:
14+
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behavior**
20+
#### Expected behavior
21+
2122
A clear and concise description of what you expected to happen.
2223

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
24+
#### Screenshots If applicable, add screenshots to help explain your problem.
25+
26+
#### Desktop (please complete the following information):
27+
28+
- OS: [e.g. iOS]
29+
- Browser [e.g. chrome, safari]
30+
- Version [e.g. 22]
2531

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
32+
#### Additional context
3033

31-
**Additional context**
32-
Add any other context about the problem here.
34+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/--feature-request.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ name: "\U0001F4A1Feature request"
33
about: Suggest an idea for this project
44
title: A short description of the feature request
55
labels: feature-request
6-
assignees: ''
7-
6+
assignees: ""
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
11-
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
9+
#### Is your feature request related to a problem? Please describe.
10+
11+
A clear and concise description of what the problem is. Example: I'm always frustrated when [...]
12+
13+
#### Describe the solution you'd like
1214

13-
**Describe the solution you'd like**
1415
A clear and concise description of what you want to happen.
1516

16-
**Describe alternatives you've considered**
17+
#### Describe alternatives you've considered
18+
1719
A clear and concise description of any alternative solutions or features you've considered.
1820

19-
**Additional context**
20-
Add any other context or screenshots about the feature request here.
21+
#### Additional context
22+
23+
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/--question.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,5 @@ name: "\U0001F914Question"
33
about: Ask a question
44
title: A short description of the question
55
labels: question
6-
assignees: ''
7-
6+
assignees: ""
87
---
9-

.github/pull_request_template.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
2-
31
## Checklist
4-
- [ ] The PR conforms to DataHub's [Contributing Guideline](https://github.com/linkedin/datahub/blob/master/docs/CONTRIBUTING.md) (particularly [Commit Message Format](https://github.com/linkedin/datahub/blob/master/docs/CONTRIBUTING.md#commit-message-format))
2+
3+
- [ ] The PR conforms to DataHub's
4+
[Contributing Guideline](https://github.com/linkedin/datahub/blob/master/docs/CONTRIBUTING.md) (particularly
5+
[Commit Message Format](https://github.com/linkedin/datahub/blob/master/docs/CONTRIBUTING.md#commit-message-format))
56
- [ ] Links to related issues (if applicable)
67
- [ ] Tests for the changes have been added/updated (if applicable)
78
- [ ] Docs related to the changes have been added/updated (if applicable)

.github/workflows/check-format.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: check format
2+
on:
3+
push:
4+
branches:
5+
- master
6+
pull_request:
7+
branches:
8+
- master
9+
release:
10+
types: [published, edited]
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up JDK 1.8
18+
uses: actions/setup-java@v1
19+
with:
20+
java-version: 1.8
21+
- name: Check format
22+
run: ./gradlew spotlessCheck
23+
- name: Slack failure notification
24+
if: failure() && github.event_name == 'push'
25+
uses: kpritam/slack-job-status-action@v1
26+
with:
27+
job-status: ${{ job.status }}
28+
slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
29+
channel: github-activities

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# General Metadata Architecture
2+
23
[![Version](https://img.shields.io/github/v/release/linkedin/datahub-gma?include_prereleases)](https://github.com/linkedin/datahub-gma/releases)
34
[![build & test](https://github.com/linkedin/datahub-gma/workflows/build%20&%20test/badge.svg?branch=master&event=push)](https://github.com/linkedin/datahub-gma/actions?query=workflow%3A%22build+%26+test%22+branch%3Amaster+event%3Apush)
45
[![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://join.slack.com/t/datahubspace/shared_invite/zt-dkzbxfck-dzNl96vBzB06pJpbRwP6RA)
@@ -7,29 +8,28 @@
78

89
---
910

10-
[Documentation](#documentation) |
11-
[Roadmap](docs/roadmap.md) |
12-
[FAQ](docs/faq.md)
11+
[Documentation](#documentation) | [Roadmap](docs/roadmap.md) | [FAQ](docs/faq.md)
1312

1413
---
1514

1615
## Introduction
16+
1717
General Metadata Architecture (GMA) is the backend for [DataHub](https://github.com/linkedin/datahub), LinkedIn's
1818
generalized metadata search & discovery tool. To learn more about DataHub, check out its
1919
[GitHub page](https://github.com/linkedin/datahub).
2020

21-
You should also visit [GMA Architecture](docs/architecture/architecture.md) to get a better understanding of how
22-
GMA is implemented and [GMA Onboarding Guide](docs/how/entity-onboarding.md) to understand how to extend GMA for your
23-
own use cases.
21+
You should also visit [GMA Architecture](docs/architecture/architecture.md) to get a better understanding of how GMA is
22+
implemented and [GMA Onboarding Guide](docs/how/entity-onboarding.md) to understand how to extend GMA for your own use
23+
cases.
2424

2525
This repository contains the _partial_ source code for GMA. It originally lived in the same GitHub repository as
2626
DataHub. We're still in the process of moving it all over.
2727

2828
## Documentation
2929

30-
* [GMA Developer's Guide](docs/developers.md)
31-
* [GMA Architecture](docs/architecture/architecture.md)
32-
* [GMA Onboarding Guide](docs/how/entity-onboarding.md)
30+
- [GMA Developer's Guide](docs/developers.md)
31+
- [GMA Architecture](docs/architecture/architecture.md)
32+
- [GMA Onboarding Guide](docs/how/entity-onboarding.md)
3333

3434
## Releases
3535

build.gradle

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ buildscript {
44
apply from: './repositories.gradle'
55
buildscript.repositories.addAll(project.repositories)
66
dependencies {
7-
classpath 'com.linkedin.pegasus:gradle-plugins:' + pegasusVersion
8-
classpath 'com.github.node-gradle:gradle-node-plugin:2.2.4'
97
classpath 'com.commercehub.gradle.plugin:gradle-avro-plugin:0.8.1'
8+
classpath 'com.diffplug.spotless:spotless-plugin-gradle:5.6.1'
9+
classpath 'com.github.node-gradle:gradle-node-plugin:2.2.4'
10+
classpath 'com.linkedin.pegasus:gradle-plugins:' + pegasusVersion
1011
classpath 'org.springframework.boot:spring-boot-gradle-plugin:2.1.2.RELEASE'
1112
classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.+'
1213
classpath "org.shipkit:shipkit-auto-version:0.0.22"
@@ -85,8 +86,8 @@ project.ext.externalDependency = [
8586
'testng': 'org.testng:testng:6.9.9'
8687
]
8788

89+
apply plugin: 'com.diffplug.spotless'
8890
apply plugin: 'org.shipkit.shipkit-auto-version'
89-
println "Building version $version"
9091

9192
allprojects {
9293
group = "com.linkedin.datahub-gma"
@@ -146,3 +147,12 @@ subprojects { sp ->
146147
}
147148
}
148149
}
150+
151+
spotless {
152+
// TODO Format Java
153+
154+
format 'md', {
155+
target '**/*.md'
156+
prettier().config([printWidth: 120, proseWrap: 'always'])
157+
}
158+
}

docs/CODE_OF_CONDUCT.md

Lines changed: 34 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,76 +2,61 @@
22

33
## Our Pledge
44

5-
In the interest of fostering an open and welcoming environment, we as
6-
contributors and maintainers pledge to making participation in our project and
7-
our community a harassment-free experience for everyone, regardless of age, body
8-
size, disability, ethnicity, sex characteristics, gender identity and expression,
9-
level of experience, education, socio-economic status, nationality, personal
10-
appearance, race, religion, or sexual identity and orientation.
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
6+
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
7+
disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
8+
socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
119

1210
## Our Standards
1311

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
12+
Examples of behavior that contributes to creating a positive environment include:
1613

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
14+
- Using welcoming and inclusive language
15+
- Being respectful of differing viewpoints and experiences
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
- Showing empathy towards other community members
2219

2320
Examples of unacceptable behavior by participants include:
2421

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
3327

3428
## Our Responsibilities
3529

36-
Project maintainers are responsible for clarifying the standards of acceptable
37-
behavior and are expected to take appropriate and fair corrective action in
38-
response to any instances of unacceptable behavior.
30+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
31+
appropriate and fair corrective action in response to any instances of unacceptable behavior.
3932

40-
Project maintainers have the right and responsibility to remove, edit, or
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, offensive, or harmful.
33+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
34+
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
35+
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
4536

4637
## Scope
4738

48-
This Code of Conduct applies both within project spaces and in public spaces
49-
when an individual is representing the project or its community. Examples of
50-
representing a project or community include using an official project e-mail
51-
address, posting via an official social media account, or acting as an appointed
52-
representative at an online or offline event. Representation of a project may be
53-
further defined and clarified by project maintainers.
39+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
40+
project or its community. Examples of representing a project or community include using an official project e-mail
41+
address, posting via an official social media account, or acting as an appointed representative at an online or offline
42+
event. Representation of a project may be further defined and clarified by project maintainers.
5443

5544
## Enforcement
5645

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by direct messaging the project team on [Slack]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
46+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by direct messaging the project team
47+
on [Slack]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and
48+
appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter
49+
of an incident. Further details of specific enforcement policies may be posted separately.
6350

64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
51+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
52+
repercussions as determined by other members of the project's leadership.
6753

6854
## Attribution
6955

70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
56+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
57+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
7258

73-
[Slack]: https://datahubspace.slack.com/join/shared_invite/zt-cl60ng6o-6odCh_I~ejZKE~a9GG30PA
59+
[slack]: https://datahubspace.slack.com/join/shared_invite/zt-cl60ng6o-6odCh_I~ejZKE~a9GG30PA
7460
[homepage]: https://www.contributor-covenant.org
7561

76-
For answers to common questions about this code of conduct, see
77-
https://www.contributor-covenant.org/faq
62+
For answers to common questions about this code of conduct, see https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)