From 9c26a38decc03551b816d21ac415e975291898e1 Mon Sep 17 00:00:00 2001 From: Leo Singer Date: Tue, 5 Nov 2024 14:44:52 -0500 Subject: [PATCH] Add contributing instructions --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 79145bc..2cd2ac6 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,22 @@ The alert format for new Notices over GCN Kafka is JavaScript Object Notation (J Please add your schema to this repository under gcn/notices/mission/ and submit a pull request for the GCN Team to review. The GCN team is happy to iterate with the producers on their schema contents and format. Your pipeline will generate JSON files following these schema and send alerts to GCN as described in [New Notice Producers](https://gcn.nasa.gov/docs/notices/producers). +## How to Contribute + +To get started, fork the [nasa-gcn/gcn-schema](https://github.com/nasa-gcn/gcn-schema) repository on GitHub and clone it on your computer. If you are new to GitHub, refer to our [GitHub primer](https://gcn.nasa.gov/docs/contributing/github). + +After you have forked and cloned the repository, make sure that Node.js and NPM are installed on your computer. There are several options to install Node.js and NPM. Pick _one_ of the following: + +- Download and run [the Node.js installer for your operating system](https://nodejs.org/en/download/). +- Install and use the [Node Version Manager, nvm](https://github.com/nvm-sh/nvm). +- Install using a [package manager](https://nodejs.org/en/download/package-manager/). + +Finally, run the following command inside the repository working directory to install the pre-commit hooks for code formatting and syntax checking: + +``` +npm install +``` + ## How To Release 1. Clone the parent repo (nasa-gcn/gcn-schema).