Contributing

Join the community and help make AI coding more secure for everyone

Ways to Contribute

💻

Code Contributions

Contribute features, fix bugs, or improve performance. All code contributions are welcome!

View Open Pull Requests
🐛

Report Bugs

Found a bug? Report it on GitHub with details about your environment and steps to reproduce.

Report a Bug
💡

Feature Requests

Have an idea for a new feature? Share it with the community and discuss how it could work.

Start a Discussion
📚

Improve Documentation

Help others by improving docs, adding examples, or translating content.

View Docs Source
🤝

Help Others

Answer questions, share your experiences, and help newcomers get started.

Join Discussions

Getting Started

1

Fork the Repository

Fork the nokey repository to your GitHub account.

git clone https://github.com/YOUR-USERNAME/nokey.git
2

Create a Branch

Create a new branch for your feature or bug fix.

git checkout -b feature/your-feature-name
3

Make Your Changes

Write code, add tests, and update documentation as needed.

4

Submit a Pull Request

Push your changes and create a pull request with a clear description of your changes.

Code of Conduct

We are committed to providing a welcoming and inclusive environment for all contributors.

  • Be respectful and considerate in all interactions
  • Welcome newcomers and help them get started
  • Focus on constructive feedback and collaboration
  • Respect different viewpoints and experiences
  • Prioritize community well-being and inclusivity

Development Setup

Prerequisites

  • Git
  • Go 1.21 or later (for backend development)
  • Node.js 18+ and npm (for website development)

Building from Source

# Clone the repository
git clone https://github.com/nokey-ai/nokey.git
cd nokey

# Build the binary
go build -o nokey

# Run tests
go test ./...

Running the Website Locally

cd website
npm install
npm run dev

Ready to Get Involved?

Join our community and help make AI coding more secure for everyone.