From a6de5b45d33b80b5ea5f3bdafc63c8a04d5262dc Mon Sep 17 00:00:00 2001 From: Kalidou Diagne Date: Sat, 15 Jun 2024 00:36:35 +0100 Subject: [PATCH 1/5] Update README.md --- data/projects/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data/projects/README.md b/data/projects/README.md index 7f0aa943..885a3097 100644 --- a/data/projects/README.md +++ b/data/projects/README.md @@ -1,6 +1,6 @@ ## Add new project to projects list -1. Add new file inside `[...]/data/projects.ts` folder +1. Add new file inside `[...]/data/projects` folder 2. Add project details inside the file already created, to easily include all the required parameters make sure to use the `ProjectInterface` ```js From f9267cb199ec3f62fde2f640cdf8d5d412050057 Mon Sep 17 00:00:00 2001 From: Kalidou Diagne Date: Sat, 15 Jun 2024 00:48:14 +0100 Subject: [PATCH 2/5] update README with better explanation --- data/projects/README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/data/projects/README.md b/data/projects/README.md index 885a3097..2f6378dc 100644 --- a/data/projects/README.md +++ b/data/projects/README.md @@ -1,7 +1,12 @@ ## Add new project to projects list -1. Add new file inside `[...]/data/projects` folder -2. Add project details inside the file already created, to easily include all the required parameters make sure to use the `ProjectInterface` +#### 1. Create a New Project File: + - Navigate to the [...]/data/projects folder within your project directory. + - Inside this folder, create a new file named example.ts. + +#### 2. Add Project Details: + - Open the newly created example.ts file. + - To ensure all necessary parameters are included, use the ProjectInterface template. Here's a basic structure to get you started: ```js export const example: ProjectInterface = { @@ -17,7 +22,22 @@ export const example: ProjectInterface = { } ``` -3. Include the exported constant of the project in `projects.ts` + - Fill in the id, image, name, and tags fields as per your project's details. The tags object includes arrays for keywords, themes, types, and builtWith. + +#### 3. Register the New Project: + - Open the projects.ts file located in the same directory or wherever your project's list is maintained. + - Add your new project to the projects array to make it visible within your application. For example: + +```js +import { example } from './projects/example'; + +const projects: ProjectInterface[] = [ + // other projects + example, +]; +``` + +By following these steps, you will successfully add a new project to your application and ensure it is correctly registered and visible. ## Show badges in the project card From 95aa30e265f764d42096a1cf9e277c58fb981f3a Mon Sep 17 00:00:00 2001 From: Kalidou Diagne Date: Sat, 15 Jun 2024 00:52:59 +0100 Subject: [PATCH 3/5] update copy for readme --- data/projects/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/data/projects/README.md b/data/projects/README.md index 2f6378dc..125dbd33 100644 --- a/data/projects/README.md +++ b/data/projects/README.md @@ -26,7 +26,7 @@ export const example: ProjectInterface = { #### 3. Register the New Project: - Open the projects.ts file located in the same directory or wherever your project's list is maintained. - - Add your new project to the projects array to make it visible within your application. For example: + - Add your new project to the projects array to make it visible: ```js import { example } from './projects/example'; @@ -37,7 +37,7 @@ const projects: ProjectInterface[] = [ ]; ``` -By following these steps, you will successfully add a new project to your application and ensure it is correctly registered and visible. +By following these steps, you will successfully add a new project and ensure it is correctly registered and visible. ## Show badges in the project card From 1806430c75f8eb207cd87f6749b72816997a9085 Mon Sep 17 00:00:00 2001 From: Kalidou Diagne Date: Fri, 28 Jun 2024 09:39:38 +0200 Subject: [PATCH 4/5] update copy --- data/projects/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/data/projects/README.md b/data/projects/README.md index dc915b5b..cef13e71 100644 --- a/data/projects/README.md +++ b/data/projects/README.md @@ -9,7 +9,7 @@ - To ensure all necessary parameters are included, use the ProjectInterface template. Here's a basic structure to get you started: ```js -export const example: ProjectInterface = { +export const project_name: ProjectInterface = { id: "project_name", image: "", name: "This is an example of the project", @@ -29,11 +29,11 @@ export const example: ProjectInterface = { - Add your new project to the projects array to make it visible: ```js -import { example } from './projects/example'; +import { project_name } from './projects/[project_name].ts'; const projects: ProjectInterface[] = [ // other projects - example, + project_name, ]; ``` From f7047f03be0192ecb541c0f7c5499f583e7f417e Mon Sep 17 00:00:00 2001 From: Kalidou Diagne Date: Fri, 28 Jun 2024 14:39:47 +0200 Subject: [PATCH 5/5] update readme --- README.md | 19 +++++++++++-------- data/projects/README.md | 11 ++++++++--- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 8f93f712..5328c130 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,23 @@ Enhancing Ethereum through cryptographic research and collective experimentation ## Contributing guidelines ### Open for contribution. -- For updating project detail, please open PR and request at least two reviewers for approval (there should be auto-assign actions, so you don't need to select manually). - For adding new features, please open PR and first merge to staging/dev for QA, or open issue for suggestion, bug report. - For any misc. update such as typo, PR to main and two approval is needed. +### Add/Edit project list +- For updating/adding project detail [you can follow this guide](https://github.com/privacy-scaling-explorations/pse.dev/blob/main/data/projects/README.md) -### Project detail now supports markdown -For PSE members who wish to add more information to the project detail, you can now add to the "description" in the {project}.ts. +## PR Review process +#### For internal, PSE member: +- Suggest to tag: @kalidiagne, @ChialiT, @AtHeartEngineer, @kichong for PR review. +- If question, please reach out in discord channel #website-pse -Supported format: -- Headings -- Table -- more to come in a later release. -Please note the keyword and theme is curated by the comms & design team. If you wish to change, please create a PR. +#### For external: +- Translation PR: please tag a member you know that can help review your translation +- Any type of PR: please state clear your intention +For any suggestion, feel free to open issue or send us a message on Discord #suggestion + ## Run Locally diff --git a/data/projects/README.md b/data/projects/README.md index cef13e71..a30568c1 100644 --- a/data/projects/README.md +++ b/data/projects/README.md @@ -98,7 +98,12 @@ This is the result ![Project links](/public/project/example-project-extra-link.png) -## Markdown supported +### Project detail now supports markdown +For PSE members who wish to add more information to the project detail, you can now add to the "description" in the {project}.ts. -You can also format the description to your liking using markdown. We supported all the heading, bold and table. -This can help the reader to quickly scan through the important information. +Supported format: +- Headings +- Table +- more to come in a later release. + +Please note the keyword and theme is curated by the comms & design team. If you wish to change, please create a PR.