From 7f752025003bd13b1bf91dc00fc5a494322defe2 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:08:14 +0530 Subject: [PATCH 01/18] chore: delete docs/commands.md as no longer need after PasscodesApp/Passcodes-Docs --- docs/commands.md | 49 ------------------------------------------------ 1 file changed, 49 deletions(-) delete mode 100644 docs/commands.md diff --git a/docs/commands.md b/docs/commands.md deleted file mode 100644 index 99c9f122..00000000 --- a/docs/commands.md +++ /dev/null @@ -1,49 +0,0 @@ -# Important Commads - -- For Building A Clean ALL Variant - -```bash -./gradlew clean assemble -``` - -- For Building A Clean Release Variant - -```bash -./gradlew clean assembleRelease -``` - -- For Building A Staging Variant - -```bash -./gradlew assembleStaging -``` - -- For Building A Debug Variant - -```bash -./gradlew assembleDebug -``` - -- For Clearing Build Files - -```bash -./gradlew clean -``` - -- For sync depeendency - -```bash -./gradlew --refresh-dependencies -``` - -- For test app - -```bash -./gradlew testDebugUnitTest -``` - -- For install app on usb connect device - -```bash -./gradlew installDebug -``` From ba808f148140cc40a5863c374fd8ae7e699d6477 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:09:47 +0530 Subject: [PATCH 02/18] chore: delete docs/database-design-guide.md as it is migrated to PasscodesApp/Passcodes-Docs --- docs/database-design-guide.md | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 docs/database-design-guide.md diff --git a/docs/database-design-guide.md b/docs/database-design-guide.md deleted file mode 100644 index 37575ba9..00000000 --- a/docs/database-design-guide.md +++ /dev/null @@ -1,34 +0,0 @@ -# Database Design & Guide - -In this file, You will find the general structure & format in which app stores users data. Also you will you will find different schema of database. - -> Some feature are not supported in sqlite3 and some might be specific to some database. but as a developer we will try our best to abstract away database concept (from frontend) as much as possible by separating database functionality in a separate module. and frontend will just call as simple as method like savePassword() or loadPassword() or something along that lines... to communicate with database... - -> [!NOTE] -> Database schema versioning system is completely separate from the app versioning system. - ---- - -## Master Database (master.db) - -**Database**: Sqlite3(`master.db`) - -It is a database where user info is stored. It schema changes often between the app versions, based on changes in feature requirements. Here, in this section you will find all the version of database schema & will also find info about how we adopted to the new schema. - -### Current Database Design (v1) - -| Tables | Description | -| ----------- | ---------------------------- | -| `passwords` | For storing password entity. | - -#### passwords table - -| Fields | Property | Constraints | Description | -| ------------ | -------- | -------------------------- | ------------------------------------------------------------------------------------------------------- | -| `id` | Integer | PRIMARY KEY, AUTOINCREMENT | -- | -| `domain` | Text | NOT NULL | domain/platform name to which password enitity is associated with. | -| `username` | Text | NOT NULL | username on that domain / platform. email can be even used as a value. | -| `password` | Text | NOT NULL | password for that specfic username on that specfic domain / platform. | -| `notes` | Text | NOT NULL | notes that you wanna take for that record. more like be some information about account on that platform | -| `created_at` | Text | DEFAULT CURRENT_TIMESTAMP | -- | -| `updated_at` | Text | DEFAULT CURRENT_TIMESTAMP | -- | From 8570338045fc38bc4ebb984f39e8c4b155b5b5db Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:11:00 +0530 Subject: [PATCH 03/18] chore: delete docs/building.md after migrate to PasscodesApp/Passcodes-Docs --- docs/building.md | 86 ------------------------------------------------ 1 file changed, 86 deletions(-) delete mode 100644 docs/building.md diff --git a/docs/building.md b/docs/building.md deleted file mode 100644 index 1fc82621..00000000 --- a/docs/building.md +++ /dev/null @@ -1,86 +0,0 @@ -# Detail Guide On Building Project - -> [!warning] -> The script `installondevice.bat` itself is deprecated by developers, -> But, it still may works!! We will provide a new solution, more likely a `powershell` more robust script soon. -> Which directly integrate with modern windows 11. and has more features.. though this script will remains as it. - -Here, you will get the details about how to build the app (in recommended way). - -Note: This docs file assume that, you are build the project without android studio and with the 'installondevice.bat' script provided. - -## Prerequisites - -You will need `gradle` and `adb` accessible from commandline so, that script can do its job. - -```powershell -adb --version -``` - -and - -```powershell -cd passcodes -./gradlew --version -``` - -Something like this... - -```powershell -PS D:\####\####\passcodes> adb --version -Android Debug Bridge version 1.0.41 -Version 35.0.2-12147458 -Installed as D:\####\####\lib\platform-tools\adb.exe -Running on Windows 10.0.26100 - -PS D:\####\####\passcodes> ./gradlew --version - ------------------------------------------------------------- -Gradle 8.14.3 ------------------------------------------------------------- - -Build time: 2025-07-04 13:15:44 UTC -Revision: e5ee1df3d88b8ca3a8074787a94f373e3090e1db - -Kotlin: 2.0.21 -Groovy: 3.0.24 -Ant: Apache Ant(TM) version 1.10.15 compiled on August 25 2024 -Launcher JVM: 17.0.12 (Oracle Corporation 17.0.12+8-LTS-286) -Daemon JVM: C:\Program Files\Java\jdk-17 (no JDK specified, using current Java home) -OS: Windows 11 10.0 amd64 -``` - -## Preparing For A Build. - -Here, are the things you required, first you will need a `keystore.properties` & `passcodes.jks` in project root. So, that the script can be able to sign the apk file when generated. Second thing you might need is a mobile device with USB debugging enable, connected to your machine, because script install the app directly using `adb`. - -### Template For keystore.properties - -``` -keyAlias=passcodes -keyPassword= -storeFile=./../passcodes.jks -storePassword= -``` - -**Fill the keyPassword and storePassword** and you are good to go. - -## Deprecated: Finial Run Script For Building - -> [!warning] -> The script `installondevice.bat` itself is deprecated by developers, -> But it still may works!! - -You can build the app for production and dev version. - -- Development Builds - - ```powershell - ./installondevice.bat - ``` - -- Production Builds - - ```powershell - ./installondevice.bat prod - ``` From 7bfc17880e74e9000472146e21202ab1a4700770 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:11:33 +0530 Subject: [PATCH 04/18] chore: delete docs/project-overiew.md after migrate PasscodesApp/Passcodes-Docs --- docs/project-overiew.md | 92 ----------------------------------------- 1 file changed, 92 deletions(-) delete mode 100644 docs/project-overiew.md diff --git a/docs/project-overiew.md b/docs/project-overiew.md deleted file mode 100644 index 6d01c5db..00000000 --- a/docs/project-overiew.md +++ /dev/null @@ -1,92 +0,0 @@ -# Passcodes Project - -An app that take down your headache of remembering password and auth related sensitive information in your head.. It is a secure and robust solution that not only, let you store password in a local storage. but also make the experience, much more fun and initiative.. - -## Outline - -- [Problem Statement](#problem-statement) -- [Goals](#goals) -- [Target Users](#target-users) -- [Priority](#priority) - -## Problem Statement - -In modern days, data is important, especially data that has concern with auth information.. and store them securely is a serious task (and much of headache). Passcodes try to eliminate this headache. by provide you a simple, sweet and initiative ui that help you store your password in local storage. (and to extend also in cloud). `which means, you have full control of data you share with passcodes app`. - -## Goals - -- To make password management process much more intuitive, enjoying, customizable & secure. By give you full (or utter more) control over your auth data. (that is shared or stored in passcodes app). -- To simplify password management, yet give extensive control to end users. -- To serve as guide, reference & extensible tool, for all people (nerds) who are interested in making there password management workflow, much more safe, secure and customizable. - -## Target Users - -1. `Not So Developer, Not So Normal-End-User` First: - - Which means, - - - For those, who wish to optimize, there password management workflow.. but don;t how to... - - For those, who are willing to spend time learning a tool (specifically for password management) & for those how are willing to uncover (disambiguate) abstraction that app uses to make the experience of storing passwords with passcode much more simpler... - - For those, who are willing to gain control of there auth data, without that extra headache of remember data that comes with it... - - For those, who don't mind researching and squirm through our documentation for hrs, just for once in a while, to customize & optimize their password management workflow... - -2. `Software Engineer` is our second target users: - - Which means, - - - the source code of the app, will much more likely to be clean, maintainable and extensible... - - developers can make the app, in way they need... we will also have documentation that one can follow & learn from, about how to extend passcodes app... - -3. `End Users` are the least target of application: - - Which means, - - - that the app will made in such way, in which we will try to abstract away the complex concepts in different extensible/decoupled systems... such that end users will more like feel that they are using a simple. but, secure password managing app... - - if you fall in this category of target users, then it more like that you will either not use the app to it full potential, or more like you will became password management nerd, as app is full optimized to promote customization and optimization of your password management workflow... - - Also, it more like a way to start using/integrating passcodes app into your daily password management workflow... but if wanna continue, then we recommend you, to try learn about your specific password management workflow and make yourself prompted from just normal end user to a more, better group (as in `Not So Developer, Not So Normal-End-User` group).. which will make you, the first target of app... which also mean that you will likely use app more effectively and will (at somepoint) end up optimizing your password management workflow, to make it more secure and customized to your specific needs... - ---- - -## Priority - -### `Customization & Extensibility is our top most priority, While simplicity is just not!!`: - -Which means app will be fully (or to it most) be extensible & customizable, without limited by any abstraction and simplification of app. We as developer will try to make the internals of app more abstract and decoupled and thus, customizable. meanwhile doing we might loss simplicity.. and the UI/UX might look more complex then need... - -Simplicity is not priority of the passcodes app. but abstracting concepts from users (as much as possible) surely is... - -## `Security is our second most priority, While performance is just not!!` - -Which clearly mean that app might have a ten different redundant, in software checks for data and user input. to ensure a robust operation.. This check might add performance overhead.. but as performance is not our priority, we might ignore this performance overhead, as we focus more on security, robustness and extensibility. - -Also, performance is not even a thing, we consider optimizing for, while making passcodes app. and it's done for better or for worse. as passcodes app is not use daily. and also we believe, that security concerns associated wih password management app is more important then any performance issue ever arise can, and sure in modern work we have high speed computer and three different redundant check won;t hurt. but an app crash or data corruption might, As the data app deals with is highly sensitive, consider end user might end up save all there account form different platform at one place.... And sure a user can wait for 2 or 3 minutes if app is not responding and doing some redundant checks just ensure data is valid... - -But that sure doesn't mean we will not focus on performance... if it became a serious issue we will try our best to solve the performance issues... but it just that, we might end up wait until something goes seriously go wrong with performance!! (e.g. app take time, to process a simple single store password action.. for straight 1 minute...) - -## Motivation - -We have pretty good and decent motivation that drive us forward, there are many previous project that back passcodes app... that were made piously by me(jeeldobariya38) and fellow contributor... - -### Kupass - -Github REPO: [Kupass](https://github.com/kudanilll/kupass). - -#### Overview - -It a simple much more intuitive password management solution.. develop by fellow contributor, daniel (@kudanill). It is one of recommended solution if you want to have easy to use app.. and don't need complexity and customization that passcodes offer you. as it simple ant intuitive.. it very much more secure as it all in your local storage... - -#### Why Quit? - -Daniel, the official owner of project, has stop provide further update as his priority change... there was no real design issue with project... it just that project was more made for eduaitional purpose and prototyping, hobby kind of purpose. - -### Smart Manager - -Github REPO: [Smart Manager](https://github.com/JeelDobariya38/Smart-Manager) - -#### Overview - -It was my first project in world of password manager and also in world of software engineering... it mostly a project, where i have made a lots of design mistakes... and try to make the code scalable and extensible and try implementing various stuff, that just don't fit together.. it perfect example, of use everything someone say is a community standard, without ever questioning why am i using it or wether is it worth adding to project.... it like if someone said use dependency injection make code better... then let just use it in our project.... - -#### Why Quit? - -The project suffer from major design issue that, I realized very later, in project timeline. it happens to reach to the point where the code was literally just mess and it just don;t have core features... so i thing to dump the app, and idea as whole... never really thought that i might come back to same idea a year after and use it to build a app in android... From 53f257e1529264cf01e3437e9ae1f4487fe9114e Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:13:10 +0530 Subject: [PATCH 05/18] chore: migrate docs/installing.md to PasscodesApp/Passcodes-Docs --- docs/installing.md | 134 --------------------------------------------- 1 file changed, 134 deletions(-) delete mode 100644 docs/installing.md diff --git a/docs/installing.md b/docs/installing.md deleted file mode 100644 index e31ee50e..00000000 --- a/docs/installing.md +++ /dev/null @@ -1,134 +0,0 @@ -# Detail Guide On Installion - -This file give you a deep guide on installion & updation process. we hope that you have already readed the step written in readme but, aren;t satisfied with that and need more info and guide on installion and updation. - -👏👏 We appreciate your efforts. As developer we try to abstract away complicated process, But sometimes this abstraction make thing simple that it is.. Which lead to false image of the process. To avoid that, we have created this guide that help you navigate installion and updation process.. - -# Table of Contents - -- [Installion Process](#installion-process) -- [Updation Process](#updation-process) -- [Guide To Find A Best Release](#guide-to-find-a-best-release) -- [Explictly Yanked Release (Pure Trash)](#explictly-yanked-release-pure-trash) - -## Installion Process - -For inital installion of app, you follow step given below it work in most scenario. - -1. Checking whether the app can run on your device or not. - - go to your setting app and check whether you are on android 8+ or not? - - if no, then sorry, app is not comatible with your device. - - and if yes, then mostly you are good to go but, officially we only support device between android 8 to 14. For more high android version app can be run, But we don;t officially support it. - -2. After completing first step, Pick a version of app to install. - - Go to our [github repository release page](https://github.com/PasscodesApp/Passcodes/releases). There you will find a list of release avaiable. - - pick up any one of the release you like. (we recommend you to pick a good release. [how can you find a good release](#guide-to-find-a-best-release)?) - - after pick up a release, you can read the changelog to know what has changed. (optional step) - -3. Downloading apk files - - after pick up a release, you can scroll to the assets and download the apk that better fits your phone cpu architecture. - - - if you don;t know your phone cpu architecture. just download the apk file that has universal in its name. - -4. Installing apk files. - - install the apk file. the apk file will be mostly like downloaded in your browser (probably like chrome, firefox or edge). - - - open the app. - -if any problem occur while performing the above 4 step. report your problem using [github issues](https://github.com/PasscodesApp/Passcodes/issues/new) after checking other support docs avaiable in github repositoy "docs/" folder. - -## Updation Process - -As you are reading this part, we hope that you have passcodes app installed on your phone and now, you want to update it. - -you can follow step given below. they work for most scenario. - -> [!IMPORTANT] -> updating from one version to another might result into data loss. though, it occur very rarely. but, it a good practice to take a backup of data. -> this try of data loss are likely to occur, when you are update from one major version to another major version meaning from `1.x.x` to `2.x.x`. - -1. Checking Whether The Update Exist Or Not - - compare your current app version with lastest app update. (you can find your current installed passcodes app version under app info in your phone settings) - - check whether a update exist or not? - - if no, then you can;t update but, can surely enquire about the next update using github issues. - - > if you know a bit of android then just clone the repo and build from main. it will work fine, because we use main branch as production. take reference from existing building docs in github. - > Ignore this if it doesn;t make sense to you.. - - - if yes, then check how big the update is and how it affect your expirence as user? - - to find the update impact you can check what the difference between your version and new version you are updating to. - > eg, if you update from 1.x.x to 2.x.x the the change will be big. if you update from 1.x.0 to 1.x.2 then change might be not visible even. - -2. Downloaded the updated apk files. - - it is same as you did earlier while installing the app. - - - goto release page and download the asset from select release. refer installion guide above if needed. - -3. Update the app. - - if, you updating to a new major release, meaning from 1.x.x to 2.x.x then, don;t forget to backup your data. you will thank your self later, if something goes wrong... - - now install the new apk file it will ask you to upgrade instead of install. - - open the app and enjoy your updated expirence. - -4. Restore the backup if need. - - if, needed restore the files/data back. or even revert to prevoius release if, problem occurs. - - - we admire the contribution even in form of your exprience with app. - - > meaning, reporting your data erase on update problem. will be appricate. - > it help us make better exprience & fix bug that might be missed by us. - ---- - -## Guide To Find A Best Release - -To find a best release you should have knowledge of passcodes versioning system and type of releases we release/publish. - -### Release Types - -On our github release page you will find majorly `5 (3+2)` type of release. Where each type of release label tell you something about release. -Each release on github may have a label but, some even lack them completely. These label tends to tell more about release, so they are IMPORTANT to consider. - -There are majorly two ways, In which we classify release. Mean a release will have two labels. -So to speak: - -- **Build Label**: a label which won't change once after release. (alpha/beta/stable) -- **Github Release Label**: a label that can change. (pre-release/latest) - -#### Three type that are there in app itself, you find them in release title on github: - -(this tags/labels can;t change after initial release of that version is done). - -- Alpha: special design for development purpose, not intented to use by end users, they comes with likely lots of bugs and security venurablitity. -- Beta: release that can be used by mass audience, and likely can contain minior bugs. -- Stable: are likey to be more stable then others release type, contain nearly zero bugs as they are very well tested. this release also will have extra developer support. - -#### Two type are specific to github release. they are label on github release itself: - -(this tags can label can change with time as they are dynamic and are not tied to app itself. meaning they are no hard coded anywhere) - -- Pre Release: this release are not so good to install or to stick with. they are generally like `marked as deperacted` or more like `yanked release` -- Latest: this release label make a release as the best up to date release to install. but latest doesn't mean stable. it means latest feature. - -> [!NOTE] -> this label or flag changes with time. meaning, a app version after it release, can be marked as pre-release as there are lots of bug found in that release later or a release can later be marked as latest release as it all good after test in production enviroment. - -So, here is a list in order where starting type are best and ending types are worse. - -``` -STABLE (the best) > LATEST > BETA > ALPHA > PRE-RELEASE > RELEASE-WITH-NO-FLAGS (the worst) > Explictly Yanked Release (Pure Trash) -``` - -It more like that a release can have two flag at a same time. for example, a stable and pre-release. In such case, consider the github base label in this case `pre-release`. as they are more dynamic and provide the latest infomation from us (developer part). - -> this clear means a pre-release even if they are stable / alpha / beta / gamma (unlikely.... 😂) -> it just doesn't matter it will be considered `the worst`... - ---- - -## Explictly Yanked Release (Pure Trash) - -This release will have Yanked Release written in the release title and description on github release page. - -Such release are just there for documentation purpose.. - -JUST DON'T USE THEM!!!! From 23d9bccbdde569c9a8035b32d8259896deb6fd4f Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Fri, 19 Sep 2025 22:13:39 +0530 Subject: [PATCH 06/18] chore: migrate docs/release-workflow.md to PasscodesApp/Passcodes-Docs --- docs/release-workflow.md | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 docs/release-workflow.md diff --git a/docs/release-workflow.md b/docs/release-workflow.md deleted file mode 100644 index cf0699ba..00000000 --- a/docs/release-workflow.md +++ /dev/null @@ -1,21 +0,0 @@ -# Release Workflow - -In this file, you will find documented process about, how we release, new version of a app. - -1. We follow, so called `Main as Production Environment`. So, during the time of release we test the main branch code. - -2. Updated the Code where ever need. (code that refer to previous version). - -3. Make Documentation up-to-date. (document the main change in app from user point of view). - -4. Update `changelog.md`. - -5. Draft a new release with all apk files uploaded (signed apks). - -6. Discuss on community and check & test release app on various parameters and - - - We run unit tests. - - We run android tests. - - And ofcourse, we internally as developers also test it (manually). - -7. Then release it. From a127c6b5c8c81ce33ca9570ecdfd842ccb05d9c5 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 18:23:37 +0530 Subject: [PATCH 07/18] chore: remove the git hooks as no longer needed --- git-hooks/commit-msg.sample | 46 ------------------------------------- 1 file changed, 46 deletions(-) delete mode 100644 git-hooks/commit-msg.sample diff --git a/git-hooks/commit-msg.sample b/git-hooks/commit-msg.sample deleted file mode 100644 index 2e1105f3..00000000 --- a/git-hooks/commit-msg.sample +++ /dev/null @@ -1,46 +0,0 @@ -#!/usr/bin/env bash - -# Path to the commit message file (provided by Git). -COMMIT_MSG_FILE=$1 - -# Ignore automatic commit messages containing ' into ' or 'Merge'. -if grep --quiet --extended-regexp " into |^Merge " "$COMMIT_MSG_FILE"; then - exit 0 -fi - -# Read the commit message from the file. -COMMIT_MSG=$(cat "$COMMIT_MSG_FILE") - -CONVENTIONAL_COMMIT_REGEX='^(feat|fix|docs|style|refactor|test|chore|build|ci|perf|revert)(\([a-z0-9_.-]+\))?(!)?:\s.*$' - -# Check if the commit message matches the regex. -if ! [[ $COMMIT_MSG =~ $CONVENTIONAL_COMMIT_REGEX ]]; then - echo "ERROR: Commit message does not follow Conventional Commits format." - echo - echo "The commit message should be structured as follows:" - echo "(): " - echo "[optional body]" - echo "[optional footer(s)]" - echo - echo "Valid types are:" - echo " feat: A new feature." - echo " fix: A bug fix." - echo " docs: Documentation changes." - echo " style: Code style changes (formatting, missing semicolons, etc.)." - echo " refactor: Code refactoring (neither fixes a bug nor adds a feature)." - echo " test: Adding or updating tests." - echo " chore: Routine tasks like updating dependencies or build tools." - echo " build: Changes affecting the build system or external dependencies." - echo " ci: Changes to CI configuration files or scripts." - echo " perf: Performance improvements." - echo " revert: Reverting a previous commit." - echo - echo "Examples:" - echo " feat(auth): add login functionality" - echo " fix(api)!: resolve timeout issue" - echo " docs(readme): update installation instructions" - echo - exit 1 -fi - -exit 0 From fe82b7aca1a1192f38afd9e8257130fea593ecb9 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 18:24:43 +0530 Subject: [PATCH 08/18] chore: update pull request template --- .github/pull_request_template.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 36c990f7..867bd495 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,19 @@ - summary 1. - summary 2. +- ... -# Notes +> summary here should be in one line (write consise so that review without take look at code, can say/determine what changed).. +> they should provide structure overview that read and understand what changed +> not a detail guide, you can provide further infomation in notes section or it would be expictily ask in pr comments at review if need..) + + +# Breaking Changes + +- [Write about any breaking changes, like architure change or databse changes etc.. If none, remove the sectio compeletly]. + + +## Notes + +[if any, otherwise remove the section] -[if any, none if remove section] From ada341f61c80df9819a257b391b6513e58eb13ac Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 21:27:36 +0530 Subject: [PATCH 09/18] docs: add link to new files --- changelog.md | 5 +++++ docs/release-notes.md | 5 +++++ docs/security-guide.md | 3 +++ 3 files changed, 13 insertions(+) diff --git a/changelog.md b/changelog.md index 80423257..113a31eb 100644 --- a/changelog.md +++ b/changelog.md @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Release Notes: [docs/release-notes.md](docs/release-notes.md), there you will find short and sweet release notes. +> [!NOTE] +> This is a raw version of the file.. +> +> Final version is over on [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/changelog.md) + ## v1.1.1 - Alpha (Sept 11, 2025) diff --git a/docs/release-notes.md b/docs/release-notes.md index 242bee41..cefc765c 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -3,6 +3,11 @@ Here, You will find short ad sweet and casual `tldrs` for release notes or changelog. For more details and more professional tone, see [changelog.md](/changelog.md). +> [!NOTE] +> This is a raw version of the file.. +> +> Final version is over on [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/release-notes.md) + ## v1.1.1-Alpha (Sept 11, 2025)
diff --git a/docs/security-guide.md b/docs/security-guide.md index 1c3630bb..9583177a 100644 --- a/docs/security-guide.md +++ b/docs/security-guide.md @@ -1,5 +1,8 @@ # Security Guide +> [!IMPORTANT] +> This file is no longer valid and is bit old.. take look at [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/security-guidelines.md) for latest changes. + Here, In this file, You can find the information about security concern that arise with saving your password with passcodes app. > [!warning] From a4711275e52ee39b79eb20b335c958a4496dc26d Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 21:28:40 +0530 Subject: [PATCH 10/18] feat: remove README.md & SECURITY.md as it not need.. --- app/src/main/assets/README.md | 119 -------------------------------- app/src/main/assets/SECURITY.md | 8 --- 2 files changed, 127 deletions(-) delete mode 100644 app/src/main/assets/README.md delete mode 100644 app/src/main/assets/SECURITY.md diff --git a/app/src/main/assets/README.md b/app/src/main/assets/README.md deleted file mode 100644 index dd8ac0c8..00000000 --- a/app/src/main/assets/README.md +++ /dev/null @@ -1,119 +0,0 @@ -# Passcodes - -[![Android CI/CD](https://github.com/PasscodesApp/Passcodes/actions/workflows/build-apks.yml/badge.svg)](https://github.com/PasscodesApp/Passcodes/actions/workflows/build-apks.yml) -![Visitor Counter (@hehuapei/visitor-badge)](https://visitor-badge.laobi.icu/badge?page_id=JeelDobariya38.Passcodes&format=true) - -> [!WARNING] -> It is just a open source project. An is current under active development. -> Please, consider using it for fun, and not for real password managment. (untill, we offically release a stable release) - -

- passcodes play store banner -

- -A android app that take down the headache of remembering passwords. It is open source solutions that help you in keeping your passwords safe and secure, in your own local storage without ever needing to push them to cloud. - -> What we think of passcodes? -> Password management is one such thing that is as simple as remember a password yet, it very important topic in term of security. So, we as developer of passcodes think to streamline and securing the process as much as possible. [Read more](docs/project-overview.md) - -## Website - -[Vist Website](https://jeeldobariya38.github.io/Passcodes-Website/) - -## Screen Shots - -
- View Here - - - - -
- -## Compatibility - -**Compile Sdk**: `Android 16 (API level 36)` - -``` -Android 8+ (Minimum) [API level 26+] -Android 14 [API level 34] (we support offically) - -Note: high version can still run, but are not guaranteed offically. -``` - -## Features - -- [x] Intuitive UI. -- [ ] Update Checkers & Manager. -- [x] Password Management. (Current Priority) -- [ ] Secure File. (Least Priority, Because it include permission. Which, I am as developer not familar with 😂) - - Could be Image. (JPG. PNG ....) - - Could be Vidoe. - - Could any Binary File. (more like won't be a text file) -- [ ] Other Secret Info Management. - - Could be note. (txt file) - - Could be any info that can encode as key & value. - ```json - { - "key": "SECRET API KEY", - "content": "qwerty-let-say", - "createdat": "...", - "updatedat": "..." - } - ``` -- [ ] NON Secret Info Store -- [ ] Encryption and Decryption. -- [ ] Backup Manager. -- [ ] Import/Export Passwords. -- [ ] Extensivity with custom database. -- [ ] Multiple Language Translation. -- [ ] Theme & Customization. -- [ ] Key Manager. -- [ ] Multi Platform Support. (KMP) - -## Installation Steps - -1. Go to our [github repository release page](https://github.com/PasscodesApp/Passcodes/releases/latest). - -2. Download the apk for your phone. If Don't know the architecture of phone then download apk file that has universal in its name. - -3. Install the apk and you are ready to use the app. - -It was most shortest and sweetest description (I have ever crafted), For more detailed description, Vist the file [docs/installing.md](docs/installing.md) - -## Building The App - -1. Clone the repository on your machine. - -2. Open the project own your Android Studio. - -3. Follow the general step and build the app. - -4. For code documention and support docs, check the `docs/` folder in our repository. - -It was general, intuitive, short and sweet description, For more detailed description, Vist the file [docs/building.md](docs/building.md). - -## Support Docs - -You can checkout support docs, provided in [docs/](docs/) Or You can even seek help on our [telegram community](https://t.me/passcodescommunity) - -## Changelog & Release Notes - -- Professional ChangeLog: [here](https://github.com/PasscodesApp/Passcodes/blob/main/changelog.md) -- Casual Release Notes: [here](https://github.com/PasscodesApp/Passcodes/blob/main/docs/release-notes.md) - -## Contribution Are Appreciated!!! - -> [!IMPORTANT] -> Currently the project (more or less also me) is not ready for (code) contributions. -> This project is currently limited by my expertise & I am beginner. Meaning I don;t want others code in my codebase, that I don't understand, I am learning android and will surely learn basic off by start of 2026.. then i will allow the contibution to this repo... But as of now i don't admire code contribution. As I am beginner in android and might have difficuly understand code that not written by me... -> -> There are still other ways to contribute to project.. like by testing app, by contributing to documenation or more or less just by spreading the word around.. about the app. but, code contribution is limited from my side.... & I hope you can understand... -> -> For more, infomation on what kind of contribtuion we approve or allow, please open a issue in our repo. that way you avoid wasteing your time... - -By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes/blob/main/LICENSE.txt). - -## Licence - -Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. diff --git a/app/src/main/assets/SECURITY.md b/app/src/main/assets/SECURITY.md deleted file mode 100644 index 83d1c6a0..00000000 --- a/app/src/main/assets/SECURITY.md +++ /dev/null @@ -1,8 +0,0 @@ -# Security Policy - -## Reporting a Vulnerability - -Report a vulnerability on a maintainer email. don't create a github issue or report publicly. - -- `dobariyaj34@gmail.com` -- `achmad24daniel@gmail.com` From d566d6098bbd788ef6bea684938db09482f55f22 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 21:38:30 +0530 Subject: [PATCH 11/18] fix: soon to be broken URLgit add . --- .../com/jeeldobariya/passcodes/utils/Constants.kt | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/app/src/main/kotlin/com/jeeldobariya/passcodes/utils/Constants.kt b/app/src/main/kotlin/com/jeeldobariya/passcodes/utils/Constants.kt index 956fb14f..24a068b5 100644 --- a/app/src/main/kotlin/com/jeeldobariya/passcodes/utils/Constants.kt +++ b/app/src/main/kotlin/com/jeeldobariya/passcodes/utils/Constants.kt @@ -2,14 +2,18 @@ package com.jeeldobariya.passcodes.utils object Constant { const val REPOSITORY_SIGNATURE = "PasscodesApp/Passcodes" + const val DOCS_REPOSITORY_SIGNATURE = "PasscodesApp/Passcodes-Docs" - // URL Constants + // Main URL Constants const val TELEGRAM_COMMUNITY_URL = "https://t.me/passcodescommunity" const val REPOSITORY_URL = "https://github.com/$REPOSITORY_SIGNATURE" + const val DOCS_REPOSITORY_URL = "https://github.com/$DOCS_REPOSITORY_SIGNATURE" + + // URL Constants const val GITHUB_RELEASE_API_URL = "https://api.github.com/repos/$REPOSITORY_SIGNATURE/releases" const val REPORT_BUG_URL = "$REPOSITORY_URL/issues/new?template=bug-report.md" - const val RELEASE_NOTE_URL = "$REPOSITORY_URL/blob/main/docs/release-notes.md" - const val SECURITY_GUIDE_URL = "$REPOSITORY_URL/blob/main/docs/security-guide.md" + const val RELEASE_NOTE_URL = "$DOCS_REPOSITORY_URL/blob/main/user-docs/release-notes.md" + const val SECURITY_GUIDE_URL = "$DOCS_REPOSITORY_URL/blob/main/user-docs/security-guidelines.md" // Shared Preferences Constants @@ -19,3 +23,4 @@ object Constant { const val FEATURE_FLAGS_PREFS_NAME = "feature_flags_prefs" const val LATEST_FEATURES_KEY = "latest_features_enabled" } + From 74ea5a12e7044b6e526be580dbbf637daf39a9fb Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 21:43:49 +0530 Subject: [PATCH 12/18] docs: add a deletion warning --- docs/security-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/security-guide.md b/docs/security-guide.md index 9583177a..906a54a7 100644 --- a/docs/security-guide.md +++ b/docs/security-guide.md @@ -2,6 +2,8 @@ > [!IMPORTANT] > This file is no longer valid and is bit old.. take look at [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/security-guidelines.md) for latest changes. +> +> This file will be deleted in Nov, 2025.. Here, In this file, You can find the information about security concern that arise with saving your password with passcodes app. From 9c212af1fa5d45ec7e5f9e5d358514e0a139ae6b Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Wed, 24 Sep 2025 21:47:29 +0530 Subject: [PATCH 13/18] docs: delete extra files as not need after PasscodesApp/Passcodes-Docs --- CONTRIBUTING.md | 130 ------------------------------------------------ SECURITY.md | 8 --- 2 files changed, 138 deletions(-) delete mode 100644 CONTRIBUTING.md delete mode 100644 SECURITY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 44632eaf..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,130 +0,0 @@ -# Contributing Guidelines - -_Pull requests, bug reports, and all other forms of contribution are welcomed and highly encouraged!_ :octocat: - -### Contents - -- [Asking Questions](#bulb-asking-questions) -- [Opening an Issue](#inbox_tray-opening-an-issue) -- [Feature Requests](#love_letter-feature-requests) -- [Triaging Issues](#mag-triaging-issues) -- [Submitting Pull Requests](#repeat-submitting-pull-requests) -- [Writing Commit Messages](#memo-writing-commit-messages) -- [Code Review](#white_check_mark-code-review) -- [Certificate of Origin](#medal_sports-certificate-of-origin) -- [Credits](#pray-credits) - -> **This guide serves to set clear expectations for everyone involved with the project so that we can improve it together while also creating a welcoming space for everyone to participate. Following these guidelines will help ensure a positive experience for contributors and maintainers.** - -## :bulb: Asking Questions - -See our [Community](https://t.me/passcodescommunity) on telegram we appricate your question over there. In short, GitHub issues are not the appropriate place to debug your specific question, but should be reserved for filing bugs and feature requests. - -## :inbox_tray: Opening an Issue - -Before [creating an issue](https://github.com/PasscodesApp/Passcodes/issues/new), check if you are using the latest version of the project. If you are not up-to-date, see if updating fixes your issue first. - -### :lock: Reporting Security Issues - -Review our [Security Policy](SECURITY.md). **Do not** file a public issue for security vulnerabilities. - -### :beetle: Bug Reports and Other Issues - -A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report. :v: - -In short, since you are most likely a developer, **provide a ticket that you would like to receive**. - -- **Review the Documentation and Support Guide** before opening a new issue. - -- **Do not open a duplicate issue!** Search through existing issues to see if your issue has previously been reported. If your issue exists, comment with any additional information you have. You may simply note "I have this problem too", which helps prioritize the most common problems and requests. - -- **Prefer using [reactions](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)**, not comments, if you simply want to "+1" an existing issue. - -- **Use [GitHub-flavored Markdown](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).** Especially put code blocks and console outputs in backticks (```). This improves readability. - -## :love_letter: Feature Requests - -Feature requests are welcome! While we will consider all requests, we cannot guarantee your request will be accepted. We want to avoid [feature creep](https://en.wikipedia.org/wiki/Feature_creep). Your idea may be great, but also out-of-scope for the project. If accepted, we cannot make any commitments regarding the timeline for implementation and release. However, you are welcome to submit a pull request to help! - -- **Do not open a duplicate feature request.** Search for existing feature requests first. If you find your feature (or one very similar) previously requested, comment on that issue. - -- Be precise about the proposed outcome of the feature and how it relates to existing features. Include implementation details if possible. - -## :mag: Triaging Issues - -You can triage issues which may include reproducing bug reports or asking for additional information, such as version numbers or reproduction instructions. Any help you can provide to quickly resolve an issue is very much appreciated! - -## :repeat: Submitting Pull Requests - -We **love** pull requests! Before [forking the repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) and [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests) for non-trivial changes, it is usually best to first open an issue to discuss the changes, or discuss your intended approach for solving the problem in the comments for an existing issue. - -For most contributions, after your first pull request is accepted and merged, you will be [invited to the project](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository) and given **push access**. :tada: - -_Note: All contributions will be licensed under the project's license._ - -- **Smaller is better.** Submit **one** pull request per bug fix or feature. A pull request should contain isolated changes pertaining to a single bug fix or feature implementation. **Do not** refactor or reformat code that is unrelated to your change. It is better to **submit many small pull requests** rather than a single large one. Enormous pull requests will take enormous amounts of time to review, or may be rejected altogether. - -- **Coordinate bigger changes.** For large and non-trivial changes, open an issue to discuss a strategy with the maintainers. Otherwise, you risk doing a lot of work for nothing! - -- **Prioritize understanding over cleverness.** Write code clearly and concisely. Remember that source code usually gets written once and read often. Ensure the code is clear to the reader. The purpose and logic should be obvious to a reasonably skilled developer, otherwise you should add a comment that explains it. - -- **Follow existing coding style and conventions.** Keep your code consistent with the style, formatting, and conventions in the rest of the code base. Consistency makes it easier to review and modify in the future. - -- **Update the example project** if one exists to exercise any new functionality you have added. - -- **Add documentation.** Document your changes with code doc comments or in existing guides. - -- **Update the CHANGELOG** for all enhancements and bug fixes. Include the corresponding issue number if one exists, and your GitHub username. (example: "- Fixed crash in profile view. #123 @jessesquires") - -- **Use the repo's default branch.** Branch from and [submit your pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) to the repo's default branch. `main`. - -- **[Resolve any merge conflicts](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github)** that occur. - -- **Promptly address any CI failures**. If your pull request fails to build or pass tests, please push another commit to fix it. - -- When writing comments, use properly constructed sentences, including punctuation. - -- Use spaces, not tabs. - -## :memo: Writing Commit Messages - -Please [write a great commit message](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716), we follow sematic commits but, don't enfore them. - -## :white_check_mark: Code Review - -- **Review the code, not the author.** Look for and suggest improvements without disparaging or insulting the author. Provide actionable feedback and explain your reasoning. - -- **You are not your code.** When your code is critiqued, questioned, or constructively criticized, remember that you are not your code. Do not take code review personally. - -- **Always do your best.** No one writes bugs on purpose. Do your best, and learn from your mistakes. - -- Kindly note any violations to the guidelines specified in this document. - -## :medal_sports: Certificate of Origin - -_Developer's Certificate of Origin 1.1_ - -By making a contribution to this project, I certify that: - -> I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. - -## [No Brown M&M's](https://en.wikipedia.org/wiki/Van_Halen#Contract_riders) - -If you are reading this, bravo dear user and (hopefully) contributor for making it this far! You are awesome. :100: - -To confirm that you have read this guide and are following it as best as possible, **include this emoji at the top** of your issue or pull request: :black_heart: `:black_heart:` - -## :pray: Credits - -Written by [@jessesquires](https://github.com/jessesquires). - -**Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.** - -_Many of the ideas and prose for the statements in this document were based on or inspired by work from the following communities:_ - -- [Alamofire](https://github.com/Alamofire/Alamofire/blob/master/CONTRIBUTING.md) -- [CocoaPods](https://github.com/CocoaPods/CocoaPods/blob/master/CONTRIBUTING.md) -- [Docker](https://github.com/moby/moby/blob/master/CONTRIBUTING.md) -- [Linux](https://elinux.org/Developer_Certificate_Of_Origin) - -_We commend them for their efforts to facilitate collaboration in their projects._ diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 83d1c6a0..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,8 +0,0 @@ -# Security Policy - -## Reporting a Vulnerability - -Report a vulnerability on a maintainer email. don't create a github issue or report publicly. - -- `dobariyaj34@gmail.com` -- `achmad24daniel@gmail.com` From 65676c4b885fe18ed2f6bf6788a7d389a843abc8 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:12:10 +0530 Subject: [PATCH 14/18] docs: Update README.md in accordance with `PasscodesApp/Passcodes-Docs` --- README.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 927bc6f7..be39f9c4 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ A android app that take down the headache of remembering passwords. It is open source solutions that help you in keeping your passwords safe and secure, in your own local storage without ever needing to push them to cloud. > What we think of passcodes? -> Password management is one such thing that is as simple as remember a password yet, it very important topic in term of security. So, we as developer of passcodes think to streamline and securing the process as much as possible. [Read more](docs/project-overview.md) +> Password management is one such thing that is as simple as remember a password yet, it very important topic in term of security. So, we as developer of passcodes think to streamline and securing the process as much as possible. [Read more](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/project-overview.md) ## Website @@ -82,7 +82,7 @@ Note: high version can still run, but are not guaranteed offically. 3. Install the apk and you are ready to use the app. -It was most shortest and sweetest description (I have ever crafted), For more detailed description, Vist the file [docs/installing.md](docs/installing.md) +It was most shortest and sweetest description (I have ever crafted), For more detailed description, Vist the file [installing.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/installing.md) in `PasscodesApp/Passcodes-Docs`. ## Building The App @@ -94,16 +94,16 @@ It was most shortest and sweetest description (I have ever crafted), For more de 4. For code documention and support docs, check the `docs/` folder in our repository. -It was general, intuitive, short and sweet description, For more detailed description, Vist the file [docs/building.md](docs/building.md). +It was general, intuitive, short and sweet description, For more detailed description, Vist the file [building.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/dev-docs/building.md) in `PasscodesApp/Passcodes-Docs`. ## Support Docs -You can checkout support docs, provided in [docs/](docs/) Or You can even seek help on our [telegram community](https://t.me/passcodescommunity) +You can checkout support docs, provided in [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs) Or You can even seek help on our [telegram community](https://t.me/passcodescommunity) ## Changelog & Release Notes -- Professional ChangeLog: [here](https://github.com/PasscodesApp/Passcodes/blob/main/changelog.md) -- Casual Release Notes: [here](https://github.com/PasscodesApp/Passcodes/blob/main/docs/release-notes.md) +- Professional ChangeLog: [here](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/changelog.md) +- Casual Release Notes: [here](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/user-docs/release-notes.md) ## Contribution Are Appreciated!!! @@ -115,8 +115,14 @@ You can checkout support docs, provided in [docs/](docs/) Or You can even seek h > > For more, infomation on what kind of contribtuion we approve or allow, please open a issue in our repo. that way you avoid wasteing your time... -By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes/blob/main/LICENSE.txt). +By, contributing to project you accept the [Terms For Contributions](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/terms-for-contributions.md), [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt). -## Licence +And also have look at [Open Contributing Timeline](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/open-contributing-timeline.md). -Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. +## Security Policy + +We follow the same security policy as the [app repository](https://github.com/PasscodesApp/Passcodes). which is avaiable in app repository over [here](https://github.com/PasscodesApp/Passcodes/blob/main/SECURITY.md). + +## License + +Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt) License. Downloading Or Use the app would mean, you are okay and have accepted the license terms. From 071e0e96702c1f10a4558c75e7f564fee701aa9b Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:13:53 +0530 Subject: [PATCH 15/18] docs: Add Read More in README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index be39f9c4..1679897e 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,8 @@ You can checkout support docs, provided in [PasscodesApp/Passcodes-Docs](https:/ > There are still other ways to contribute to project.. like by testing app, by contributing to documenation or more or less just by spreading the word around.. about the app. but, code contribution is limited from my side.... & I hope you can understand... > > For more, infomation on what kind of contribtuion we approve or allow, please open a issue in our repo. that way you avoid wasteing your time... +> +> [Read More](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/open-contributing-timeline.md) By, contributing to project you accept the [Terms For Contributions](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/terms-for-contributions.md), [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt). From 7a529cb74ebe3ccda07b18ea914dda2c6e8bc880 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:30:45 +0530 Subject: [PATCH 16/18] docs: Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1679897e..b84def9a 100644 --- a/README.md +++ b/README.md @@ -123,8 +123,8 @@ And also have look at [Open Contributing Timeline](https://github.com/PasscodesA ## Security Policy -We follow the same security policy as the [app repository](https://github.com/PasscodesApp/Passcodes). which is avaiable in app repository over [here](https://github.com/PasscodesApp/Passcodes/blob/main/SECURITY.md). +Avaliable here in [PasscodesApp/Passcodes-Docs](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/SECURITY.md). ## License -Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt) License. Downloading Or Use the app would mean, you are okay and have accepted the license terms. +Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt) License. Downloading Or Use the app or any associated stuff would mean, you are okay and have accepted the license terms. From b4b208a6d93bf18c3843af2610573a0dfeee2e37 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:39:14 +0530 Subject: [PATCH 17/18] chore: improve format in README.md --- README.md | 41 +++++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index b84def9a..d4b0f7d7 100644 --- a/README.md +++ b/README.md @@ -47,31 +47,44 @@ Note: high version can still run, but are not guaranteed offically. ## Features - [x] Intuitive UI. + - [ ] Update Checkers & Manager. + - [x] Password Management. (Current Priority) + - [ ] Secure File. (Least Priority, Because it include permission. Which, I am as developer not familar with 😂) - - Could be Image. (JPG. PNG ....) - - Could be Vidoe. - - Could any Binary File. (more like won't be a text file) + - Could be Image. (JPG. PNG ....) + - Could be Vidoe. + - Could any Binary File. (more like won't be a text file) + - [ ] Other Secret Info Management. - - Could be note. (txt file) - - Could be any info that can encode as key & value. - ```json - { - "key": "SECRET API KEY", - "content": "qwerty-let-say", - "createdat": "...", - "updatedat": "..." - } - ``` -- [ ] NON Secret Info Store + - Could be note. (txt file) + - Could be any info that can encode as key & value. + ```json + { + "key": "SECRET API KEY", + "content": "qwerty-let-say", + "createdat": "...", + "updatedat": "..." + } + ``` + +- [ ] NON Secret Info Store. + - [ ] Encryption and Decryption. + - [ ] Backup Manager. + - [ ] Import/Export Passwords. + - [ ] Extensivity with custom database. + - [ ] Multiple Language Translation. + - [ ] Theme & Customization. + - [ ] Key Manager. + - [ ] Multi Platform Support. (KMP) ## Installation Steps From 2687a3f77e73ac83acb548edbae875772e43095d Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:40:49 +0530 Subject: [PATCH 18/18] chore: format README.md --- README.md | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d4b0f7d7..b6b8de81 100644 --- a/README.md +++ b/README.md @@ -47,44 +47,31 @@ Note: high version can still run, but are not guaranteed offically. ## Features - [x] Intuitive UI. - - [ ] Update Checkers & Manager. - - [x] Password Management. (Current Priority) - - [ ] Secure File. (Least Priority, Because it include permission. Which, I am as developer not familar with 😂) - Could be Image. (JPG. PNG ....) - Could be Vidoe. - Could any Binary File. (more like won't be a text file) - - [ ] Other Secret Info Management. - Could be note. (txt file) - Could be any info that can encode as key & value. - ```json - { - "key": "SECRET API KEY", - "content": "qwerty-let-say", - "createdat": "...", - "updatedat": "..." - } - ``` - +```json +{ + "key": "SECRET API KEY", + "content": "qwerty-let-say", + "createdat": "...", + "updatedat": "..." +} +``` - [ ] NON Secret Info Store. - - [ ] Encryption and Decryption. - - [ ] Backup Manager. - - [ ] Import/Export Passwords. - - [ ] Extensivity with custom database. - - [ ] Multiple Language Translation. - - [ ] Theme & Customization. - - [ ] Key Manager. - - [ ] Multi Platform Support. (KMP) ## Installation Steps