Skip to content

Commit

Permalink
Merge pull request finos#626 from finos/branding-and-style-touchups
Browse files Browse the repository at this point in the history
chore: propagate renaming to remaining files
  • Loading branch information
JamieSlome committed Jun 22, 2024
2 parents 3844985 + 6ad202e commit 5401677
Show file tree
Hide file tree
Showing 12 changed files with 41 additions and 52 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Code of Conduct for Git Proxy
# Code of Conduct for GitProxy

Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct).
36 changes: 20 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Git Proxy Contribution and Governance Policies
# GitProxy Contribution and Governance Policies

This document describes the contribution process and governance policies of the FINOS Git Proxy project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy](IP-Policy.pdf), [Code of Conduct](Code-of-Conduct.md), [Collaborative Principles](Collaborative-Principles.md), and [Meeting Procedures](Meeting-Procedures.md).
This document describes the contribution process and governance policies of the FINOS GitProxy project. The project is also governed by the [Linux Foundation Antitrust Policy](https://www.linuxfoundation.org/antitrust-policy/), and the FINOS [IP Policy](IP-Policy.pdf), [Code of Conduct](Code-of-Conduct.md), [Collaborative Principles](Collaborative-Principles.md), and [Meeting Procedures](Meeting-Procedures.md).

## Contribution Process

Before making a contribution, please take the following steps:

1. Check whether there's already an open issue related to your proposed contribution. If there is, join the discussion and propose your contribution there.
2. If there isn't already a relevant issue, create one, describing your contribution and the problem you're trying to solve.
3. Respond to any questions or suggestions raised in the issue by other developers.
Expand All @@ -21,33 +22,36 @@ NOTE: All contributors must have a contributor license agreement (CLA) on file w
### Roles

The project community consists of Contributors and Maintainers:
* A **Contributor** is anyone who submits a contribution to the project. (Contributions may include code, issues, comments, documentation, media, or any combination of the above.)
* A **Maintainer** is a Contributor who, by virtue of their contribution history, has been given write access to project repositories and may merge approved contributions.
* The **Lead Maintainer** is the project's interface with the FINOS team and Board. They are responsible for approving [quarterly project reports](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/93225748/Board+Reporting+and+Program+Health+Checks) and communicating on behalf of the project. The Lead Maintainer is elected by a vote of the Maintainers.

- A **Contributor** is anyone who submits a contribution to the project. (Contributions may include code, issues, comments, documentation, media, or any combination of the above.)
- A **Maintainer** is a Contributor who, by virtue of their contribution history, has been given write access to project repositories and may merge approved contributions.
- The **Lead Maintainer** is the project's interface with the FINOS team and Board. They are responsible for approving [quarterly project reports](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/93225748/Board+Reporting+and+Program+Health+Checks) and communicating on behalf of the project. The Lead Maintainer is elected by a vote of the Maintainers.

### Contribution Rules

Anyone is welcome to submit a contribution to the project. The rules below apply to all contributions. (The key words "MUST", "SHALL", "SHOULD", "MAY", etc. in this document are to be interpreted as described in [IETF RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).)

* All contributions MUST be submitted as pull requests, including contributions by Maintainers.
* All pull requests SHOULD be reviewed by a Maintainer (other than the Contributor) before being merged.
* Pull requests for non-trivial contributions SHOULD remain open for a review period sufficient to give all Maintainers a sufficient opportunity to review and comment on them.
* After the review period, if no Maintainer has an objection to the pull request, any Maintainer MAY merge it.
* If any Maintainer objects to a pull request, the Maintainers SHOULD try to come to consensus through discussion. If not consensus can be reached, any Maintainer MAY call for a vote on the contribution.
- All contributions MUST be submitted as pull requests, including contributions by Maintainers.
- All pull requests SHOULD be reviewed by a Maintainer (other than the Contributor) before being merged.
- Pull requests for non-trivial contributions SHOULD remain open for a review period sufficient to give all Maintainers a sufficient opportunity to review and comment on them.
- After the review period, if no Maintainer has an objection to the pull request, any Maintainer MAY merge it.
- If any Maintainer objects to a pull request, the Maintainers SHOULD try to come to consensus through discussion. If not consensus can be reached, any Maintainer MAY call for a vote on the contribution.

### Maintainer Voting

The Maintainers MAY hold votes only when they are unable to reach consensus on an issue. Any Maintainer MAY call a vote on a contested issue, after which Maintainers SHALL have 36 hours to register their votes. Votes SHALL take the form of "+1" (agree), "-1" (disagree), "+0" (abstain). Issues SHALL be decided by the majority of votes cast. If there is only one Maintainer, they SHALL decide any issue otherwise requiring a Maintainer vote. If a vote is tied, the Lead Maintainer MAY cast an additional tie-breaker vote.

The Maintainers SHALL decide the following matters by consensus or, if necessary, a vote:
* Contested pull requests
* Election and removal of the Lead Maintainer
* Election and removal of Maintainers

- Contested pull requests
- Election and removal of the Lead Maintainer
- Election and removal of Maintainers

All Maintainer votes MUST be carried out transparently, with all discussion and voting occurring in public, either:
* in comments associated with the relevant issue or pull request, if applicable;
* on the project mailing list or other official public communication channel; or
* during a regular, minuted project meeting.

- in comments associated with the relevant issue or pull request, if applicable;
- on the project mailing list or other official public communication channel; or
- during a regular, minuted project meeting.

### Maintainer Qualifications

Expand Down
2 changes: 1 addition & 1 deletion certs/create-cert.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#! /bin/bash

# Generates a self-signed certificate used for the SSL Certificate used by the Git Proxy HTTPS endpoint
# Generates a self-signed certificate used for the SSL Certificate used by the GitProxy HTTPS endpoint

# The certificate expires in 10 years (9 May 2034)
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/C=US/ST=NY/L=New York/O=FINOS/OU=CTI/CN=localhost"
2 changes: 1 addition & 1 deletion config.schema.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://json-schema.org/draft-07/schema",
"$id": "https://git-proxy.finos.org/config.schema.json",
"title": "Git Proxy configuration file",
"title": "GitProxy configuration file",
"description": "Configuration for customizing git-proxy",
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>Git Proxy</title>
<title>GitProxy</title>
</head>
<body>
<noscript> You need to enable JavaScript to run this app. </noscript>
Expand Down
12 changes: 6 additions & 6 deletions packages/git-proxy-cli/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const baseUrl = `${uiHost}:${uiPort}`;
axios.defaults.timeout = 30000;

/**
* Log in to Git Proxy
* Log in to GitProxy
* @param {string} username The user name to login with
* @param {string} password The password to use for the login
*/
Expand Down Expand Up @@ -155,11 +155,11 @@ async function authoriseGitPush(id) {
params: {
attestation: [
{
label: "Authorising via GitProxy CLI",
checked: true
}
]
}
label: 'Authorising via GitProxy CLI',
checked: true,
},
],
},
},
{
headers: { Cookie: cookies },
Expand Down
2 changes: 1 addition & 1 deletion packages/git-proxy-cli/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@finos/git-proxy-cli",
"version": "0.1.0",
"description": "Command line interface tool for FINOS Git Proxy.",
"description": "Command line interface tool for FINOS GitProxy.",
"bin": "./index.js",
"dependencies": {
"axios": "^1.6.0",
Expand Down
21 changes: 4 additions & 17 deletions packages/git-proxy-cli/test/testCliUtils.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ async function runCli(

/**
* Starts the server.
* @param {Object} service - The Git Proxy API service to be started.
* @param {Object} service - The GitProxy API service to be started.
* @return {Promise<void>} A promise that resolves when the service has
* successfully started. Does not return any value upon resolution.
*/
Expand Down Expand Up @@ -183,7 +183,7 @@ async function addGitPushToDb(id, repo, debug = false) {
false, // error
null, // errorMessage
true, // blocked
`\n\n\nGit Proxy has received your push:\n\nhttp://localhost:8080/requests/${id}\n\n\n`, // blockedMessage
`\n\n\nGitProxy has received your push:\n\nhttp://localhost:8080/requests/${id}\n\n\n`, // blockedMessage
null, // content
);
const commitData = [];
Expand Down Expand Up @@ -212,21 +212,8 @@ async function addGitPushToDb(id, repo, debug = false) {
* @param {boolean} admin Flag to make the user administrator.
* @param {boolean} debug Flag to enable logging for debugging.
*/
async function addUserToDb(
username,
password,
email,
gitAccount,
admin = false,
debug = false,
) {
const result = await db.createUser(
username,
password,
email,
gitAccount,
admin,
);
async function addUserToDb(username, password, email, gitAccount, admin = false, debug = false) {
const result = await db.createUser(username, password, email, gitAccount, admin);
if (debug) {
console.log(`New user added to DB: ${util.inspect(result)}`);
}
Expand Down
4 changes: 2 additions & 2 deletions scripts/doc-schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ try {

const schemaDoc = readFileSync(`${tempdir}${sep}schema.md`, 'utf-8')
.replace(/\n\n<\/summary>/g, '</summary>')
.replace(/# Git Proxy configuration file/g, '# Schema Reference'); // https://github.com/finos/git-proxy/pull/327#discussion_r1377343213
.replace(/# GitProxy configuration file/g, '# Schema Reference'); // https://github.com/finos/git-proxy/pull/327#discussion_r1377343213
const docString = `---
title: Schema Reference
description: JSON schema reference documentation for Git Proxy
description: JSON schema reference documentation for GitProxy
---
${schemaDoc}
Expand Down
6 changes: 2 additions & 4 deletions src/plugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,7 @@ class PluginLoader {
*/
async _loadFilePlugin(filepath) {
const lp = await lpModule;
const resolvedModuleFile = await lp.resolvePlugin(
path.join(process.cwd(), filepath),
);
const resolvedModuleFile = await lp.resolvePlugin(path.join(process.cwd(), filepath));
return await lp.loadPlugin(resolvedModuleFile);
}

Expand Down Expand Up @@ -100,7 +98,7 @@ class PluginLoader {
}

/**
* Parent class for all Git Proxy plugins. New plugin types must inherit from
* Parent class for all GitProxy plugins. New plugin types must inherit from
* ProxyPlugin to be loaded by PluginLoader.
*/
class ProxyPlugin {}
Expand Down
2 changes: 1 addition & 1 deletion src/proxy/processors/push-action/blockForAuth.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ const exec = async (req, action) => {

const message =
'\n\n\n' +
`\x1B[32mGit Proxy has received your push ✅\x1B[0m\n\n` +
`\x1B[32mGitProxy has received your push ✅\x1B[0m\n\n` +
'🔗 Shareable Link\n\n' +
`\x1B[34mhttp://localhost:${uiPort}/admin/push/${action.id}\x1B[0m` +
'\n\n\n';
Expand Down
2 changes: 1 addition & 1 deletion src/ui/components/Footer/Footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default function Footer(props) {
</List>
</div>
<p className={classes.right}>
<span>&copy; {1900 + new Date().getYear()} Git Proxy</span>
<span>&copy; {1900 + new Date().getYear()} GitProxy</span>
</p>
</div>
</footer>
Expand Down

0 comments on commit 5401677

Please sign in to comment.