When contributing to this repository, please first discuss the change you wish to make via issue on this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project.
This project need:
- Go version >= v1.20.x
- NodeJS >= v20.7.x
Project Git Branch:
master
release branchdev
dev consolidate branch
To set up a development environment, please follow these steps:
-
Clone the repo (and/or switch to consolidate
dev
branch)git clone https://github.com/openivity/openivity.github.io git checkout dev # Optional, dev branch
-
Install node dependencies
npm install
-
Prepare required files such as copying
wasm_exec.js
of your current version of Go in your local machine tosrc/assets/wasm/wasm_exec.js
. This file is tightly coupled with a specific version of Go in order to compile the WebAssembly binary.npm run init
-
Compile Go source code into wasm binary.
npm run build-wasm
-
Finally, now you can run the project
npm run dev
-
Type-Check, Compile and Minify for Production
npm run build-wasm npm run build-only
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub. Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed!
Please try to create bug reports that are:
- Reproducible. Include steps to reproduce the problem.
- Specific. Include as much detail as possible: which version, what environment, etc.
- Unique. Do not duplicate existing opened issues.
- Scoped to a Single Bug. One bug per report.
Even better: Submit a pull request with a fix or new feature!
- Search our repository for open or closed Pull Requests that relate to your submission. You don't want to duplicate effort.
- Fork the project
- Create your feature branch (
git checkout -b feat/amazing_feature
) - Commit your changes (
git commit -m 'feat: add amazing_feature'
) - Push to the branch (
git push origin feat/amazing_feature
) - Open a Pull Request