From d87eb7b646507f711f7d6796f29337dce705f5b2 Mon Sep 17 00:00:00 2001 From: Satarupa Deb <84276219+Satarupa22-SD@users.noreply.github.com> Date: Thu, 20 Jul 2023 20:24:41 +0530 Subject: [PATCH 1/4] Update README.md --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4cea7d2..7ddd9a4 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,18 @@ Then: * `make test` will run [FontBakery](https://github.com/googlefonts/fontbakery)'s quality assurance tests. * `make proof` will generate HTML proof files. +## Contributing Guidelines: +We appreciate your desire to support the Overpass font family project. We value your assistance and are excited about your contributions. +There are several ways to contribute to the Overpass font family project: + +* Bug Reports: If you encounter any issues or bugs related to the fonts or the building process, Please submit a new issue with an in-depth description of the issue, the necessary steps to reproduce it, and any relevant details . + +* Feature Requests: Please open a feature request issue to discuss and document your suggestions for any additional features, upgrades, or enhancements to the font family. + +* Documentation: Improvements to the README file, code comments, or new guidelines are all welcome contributions to the project's documentation. + +* Code Contributions: If you are a developer, you may help the project by adding new features, implementing bug fixes, or enhancing the codebase. + ## License Copyright 2016 Red Hat, Inc., @@ -46,4 +58,4 @@ OFL 1.1 : http://scripts.sil.org/OFL ## Repository Layout -This font repository structure is inspired by [Unified Font Repository v0.3](https://github.com/unified-font-repository/Unified-Font-Repository), modified for the Google Fonts workflow. \ No newline at end of file +This font repository structure is inspired by [Unified Font Repository v0.3](https://github.com/unified-font-repository/Unified-Font-Repository), modified for the Google Fonts workflow. From 2964d29feac65ee401cd5fc4b8df00a802e135ca Mon Sep 17 00:00:00 2001 From: Satarupa Deb <84276219+Satarupa22-SD@users.noreply.github.com> Date: Thu, 20 Jul 2023 20:27:11 +0530 Subject: [PATCH 2/4] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 7ddd9a4..bb3b056 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,14 @@ There are several ways to contribute to the Overpass font family project: * Code Contributions: If you are a developer, you may help the project by adding new features, implementing bug fixes, or enhancing the codebase. +## Code Style and Standards + +When contributing code, please adhere to the following guidelines: + +* Follow the existing code style and formatting used in the project. +* Write clear and concise commit messages. +* Keep code changes focused and limited to the scope of the pull request. + ## License Copyright 2016 Red Hat, Inc., From f9cf29da7d8fdf29c8c93c8366f7f3cfa4e02f21 Mon Sep 17 00:00:00 2001 From: Satarupa Deb <84276219+Satarupa22-SD@users.noreply.github.com> Date: Thu, 20 Jul 2023 20:27:41 +0530 Subject: [PATCH 3/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bb3b056..9d7cd16 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ Then: * `make test` will run [FontBakery](https://github.com/googlefonts/fontbakery)'s quality assurance tests. * `make proof` will generate HTML proof files. -## Contributing Guidelines: +## Contributing Guidelines We appreciate your desire to support the Overpass font family project. We value your assistance and are excited about your contributions. There are several ways to contribute to the Overpass font family project: From 5fc765359485459b2fa1c225577b2feb98512d51 Mon Sep 17 00:00:00 2001 From: Satarupa Deb <84276219+Satarupa22-SD@users.noreply.github.com> Date: Fri, 21 Jul 2023 01:19:51 +0530 Subject: [PATCH 4/4] Update README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 9d7cd16..f3fc8d0 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,29 @@ When contributing code, please adhere to the following guidelines: * Write clear and concise commit messages. * Keep code changes focused and limited to the scope of the pull request. +## Development Instructions + +* Clone the Overpass font repository to your local machine: + ---- + `git clone https://github.com/overpassfont/overpass.git + cd overpass` + +* Install the required dependencies: + ---- + ` npm install ` + +* Building Fonts: + To build the font files, run the following command: + ---- + `npm run build` + +* To generate HTML proof files, use the command: + ---- + `npm run proof` + + + + ## License Copyright 2016 Red Hat, Inc.,