Skip to content

Added Contributing guidelines #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Satarupa22-SD wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Added Contributing guidelines #97

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d87eb7b
Update README.md
Satarupa22-SD Jul 20, 2023
2964d29
Update README.md
Satarupa22-SD Jul 20, 2023
f9cf29d
Update README.md
Satarupa22-SD Jul 20, 2023
5fc7653
Update README.md
Satarupa22-SD Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 44 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.,
Expand All @@ -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.
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.