diff --git a/README.md b/README.md index 4cea7d2..f3fc8d0 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,49 @@ 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. + +## 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. + +## 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., @@ -46,4 +89,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.