Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 2.67 KB

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

We release new versions of this project (maintenance/features) on a monthly cadence so please be aware that some items will not get released right away.

Pull Request Process

You can contribute changes to this repo by opening a pull request:

  1. After forking this repository to your Git account, make the proposed changes on your forked branch.
  2. Go to the README.md file as it has detailed instructions on how to run the project locally and how to test the integrations.
  3. Commit your changes and push them to your forked repository.
  4. Navigate to the main Airhorn repository and select the Pull Requests tab.
  5. Click the New pull request button, then select the option "Compare across forks"
  6. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
  7. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
  8. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
  9. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the Airhorn repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the Github documentation

Setting up the Development Environment

To set up your development environment, you'll need the following dependencies:

  • Node.js (latest)
pnpm i && pnpm test

If you are using nvm you can run the following:

nvm use && pnpm i && pnpm test

This will ensure that you are using the correct version of Node.js and install the dependencies.

Publishing Airhorn

To publish Airhorn to npm you first want to set the overall version in the package.json file. You can do this by updating the version field. Once you have done that then call:

pnpm version:sync

Code of Conduct

Please refer to our Code of Conduct readme for how to contribute to this open source project and work within the community.