Skip to content

Latest commit

 

History

History
43 lines (32 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

43 lines (32 loc) · 2.31 KB

Contributing to Shielded Secret

Thank you for considering contributing to Shielded Secret! We appreciate your interest in helping us make this project even better. Whether you're an experienced developer or just getting started with Golang or Svelte, this project is a great opportunity for you to learn and contribute to open source.

Getting Started

Before you start contributing, here are a few things you need to know:

  • Shielded Secret is primarily written in Golang and utilizes Svelte for its frontend.
  • We welcome contributions from developers of all levels, from beginners to experts.
  • If you're new to Golang or Svelte, this project is a fantastic way to dive into these technologies while contributing to a real-world application.
  • You can contribute by fixing bugs, adding new features, improving documentation, or even just by reporting issues and suggesting enhancements.

How to Contribute

  • Fork the Repository: If you haven't already, fork the Shielded Secret repository to your GitHub account. You'll work on your changes in your own copy of the project.
  • Clone the Repository: Clone your fork of the project to your local machine. 
    git clone https://github.com/your-username/shielded-secret.git
  • Create a new branch and commit your changes
  • Test your changes before opening pull request with the original repo

Issues and Feature Requests

If you're not ready to contribute code just yet, you can still help by opening and commenting on issues. You can report bugs, suggest new features, or simply share your ideas and feedback. We value your input!

Roadmap

  • Fix the envelope for API response. (especially for meta)
  • Support TLS with lets encrypt.
  • Support basic auth.
  • Support trusted IP.
  • Add contributing.md
  • Embed FE in Go and ship single binary
  • Add Dockerfile and document instructions for how to deploy this app on prod.
  • Support itegration with Slack and notify channels when secret gets updated.
  • Write unit tests
  • Support multiple AWS accounts.

Thank You!

Your contributions to Shielded Secret are valuable to the project and the open-source community as a whole. We appreciate your time and effort in making this project better for everyone. If you have any questions or need assistance, feel free to reach out to us.

Happy coding! 🚀