Skip to content

Latest commit

 

History

History
49 lines (35 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 3.59 KB
Raw

Contributing

When contributing to this repository, propose the changes you wish to make via Feature Request issues, or Discussions.

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

Pull Request Process

  • Create pull requests to the "develop" branch.
  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md/docs with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

Getting started

  • Have you read the Code of Conduct?
  • Check out the existing issues if someone is already working on the issue you are facing.
  • If you don't see an issue, open one using the provided templates.
  • Fork the repo.
  • Since Camouflage is built using Node.js, please ensure your development environment has Node >v14.
  • Make your changes. If you are not sure where to start, referring to the JSDocs might help.
  • Open a Pull Request.
  • Submit PR and get it reviewed.

Types of contributions

There are several ways you can contribute to Camouflage.

Discussions 💬

Discussions are where we have conversations.

If you'd like help troubleshooting a PR you're working on, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

Star 🌟

Simplest way to contribute to Camouflage is to star the project. This helps increase the popularity of Camouflage which in turns brings more people. More people using Camouflage leads to more bugs being identified and new ideas and features being implemented and thereby increasing the overall stability and usability the tool. Each star changes the course this project could take to it's future.

Issues 🪲

If you find something in Camouflage that doesn't seem to be working as expected, or you'd like to propose a new feature, go through the existing issues to see if someone has encoutered the same issue earlier. If not you can create a new issue.

Documentation 📖

All devs hate documentation. So it's likely there are mistakes in the Camouflage documentation too. Find one for easiest contributions. You could even help translate the documentation to other languages.

Spread the word 📣

Finally and most importantly, spread the word. You can:

  • For any open source project, the biggest motivation is its users. Let us know ([email protected]) if you are using or planning to use Camouflage and let us help you get started.
  • Write blogs or Create YouTube How-Tos. Share the link with us so that your articles and videos can be featured on README.
  • If you plan to use Camouflage in your organization, request them to let us feature the organization on our README.
  • Write reviews in the Discussions sections.
  • Star and fork the repo.