Skip to main content

How to Contribute

Thank you for considering contributing to OpenKeyNav! We welcome your contributions. Here are some guidelines to help you get started.

Contributor License Agreement (CLA)​

Before we can accept your contributions, you need to sign our CLA. This ensures that the project can legally use your contributions.

To sign the CLA, please visit our CLA page.

Contribution Process​

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Make your changes.
  4. Ensure your changes pass existing tests.
  5. Commit your changes.
  6. Open a pull request.
  7. Visit our CLA page and follow the instructions to sign the CLA.

Detailed Steps​

Step 1: Fork the Repository​

Fork the OpenKeyNav repository on GitHub to your own account.

Step 2: Clone the Repository​

Clone your forked repository to your local machine:

git clone https://github.com/YOUR_GITHUB_USERNAME/OpenKeyNav.git
cd OpenKeyNav

Step 3: Create a New Branch​

Create a new branch for your feature or bugfix:

git checkout -b my-feature-branch

Step 4: Make Your Changes​

Make the necessary changes to the codebase. The source files are located in the src directory.

Step 5: Test Your Changes​

You can test your changes by including the outputted files in a webpage or by importing the package locally.

Step 6: Commit Your Changes​

Once you have made and tested your changes, commit them to your local repository:

git add .
git commit -m "Description of your changes"

Step 7: Push to Your Fork​

Push your changes to your forked repository on GitHub:

git push origin my-feature-branch

Step 8: Sign the CLA​

Visit our CLA page and follow the instructions to sign the CLA.

Step 9: Create a Pull Request​

Go to the original OpenKeyNav repository and create a pull request to merge your changes. Provide a clear description of the changes you have made and why they should be merged.

Summary​

By following these steps, you can contribute to OpenKeyNav and help improve the project. If you have any questions or need further assistance, feel free to reach out to the community. We appreciate your contributions and look forward to collaborating with you!