Thank you for investing your time and effort into contributing to our project! Any contribution you make is most welcome ✨.
Please read the Github Code of Conduct to keep our community approachable and respectable.
In this guide you will get an overview of the contribution workflow from cloning the repository, opening an issue, forking the repository & creating a pull request, pull request review, and then merging the pull request.
Use the table of contents icon to get to a specific section of this guide quickly.
Anyone (and any company) can clone the repository and use or modify the software ✨. The only caveat is that you must disclose your modifications (ideally by reintegrating them into our reposotiry with a pull request). Using a modified version of this software without disclosing its source code is not in compliance with the AGPL-3.0 license.
To get an overview of the project, please read the README file. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
To navigate our codebase with confidence, please see our README 🎊. For more information on markdown files and syntax, see "Using Markdown and Liquid on GitHub."
Once you've cloned the repository and famliarized yourself with our software, if you have a feature request or spot a problem with a component of the code, search to see if an issue already exists. If a related issue doesn't exist, you can open a new issue using the Issues page of this repository.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a pull request with a fix.
- Fork the repository. We use forks so that you can make your changes and test them without affecting the original project until you're ready to merge them.
-
Uaing VS Code:
-
Using GitHub Desktop:
- Getting started with GitHub Desktop will guide you through setting up Github Desktop.
- Once Github Desktop is set up, you can use it to fork the repo!
-
Using the command line:
- Clone the forked repo (branch) you created and start with your changes!
Commit and push your changes to your branch once you are happy with them ⚡.
Please reference and adhere to our pull request tepmlate when filing your pull request.
Once you've thoroughly tested and debugged your changes, create a pull request (sometimes referred to on Github as a PR) in this repo. Describe to the reviewers what changes you've made as well as the purpose of your pull request.
- Don't forget to link pull request to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your pull request, a team member will review your proposal. We may ask questions or request additional information.
- We may ask for changes to be made before a pull request can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your pull request and apply changes, mark each conversation as resolved.
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
After review, your pull request will either be approved (in which case congratulations on your contributions 🎉🎉! The env_encryption_tool team thanks you ✨), or we'll consult with you about additional changes we believe are needed.