From 7406d17685ba776bd9e99b2b37d8afd9ffdc1fe0 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya Date: Tue, 16 Sep 2025 18:20:14 +0530 Subject: [PATCH 1/8] docs: update readme with telegram single source --- profile/README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/profile/README.md b/profile/README.md index 903eaaf..f094248 100644 --- a/profile/README.md +++ b/profile/README.md @@ -11,7 +11,7 @@ A android app that take down the headache of remembering passwords. It is open s ## Website -[Vist Website](https://jeeldobariya38.github.io/Passcodes-Website/) +[Vist Website](https://passcodesapp.github.io/Passcodes-Website/) ## Compatibility @@ -36,7 +36,13 @@ Note: high version can still run, but are not guaranteed offically. By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/PasscodesApp/.github/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/.github/blob/main/LICENSE.txt). +## Community & Discussions + +You can ask or discuss casually on our [telegram community](https://t.me/passcodescommunity). But for more important discussion and professional discussion (related to security or major migration doubt), create a thread on github discussion in associated repository. telegram community link or handle will not change.. atleast not that fast... + +> [!IMPORTANT] +> Also consider our telegram community as single source of truth in any situation.. so please join there!! because other link of website or of github repository might change over time... + ## Licence Passcodes Project is license under [MIT](https://github.com/PasscodesApp/.github/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. - From b498d6d0236e3da8ea316f6cfedcf82d4aee58f2 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 19:50:54 +0530 Subject: [PATCH 2/8] refactor: Remove CONTRIBUTING.md as not needed --- CONTRIBUTING.md | 131 ------------------------------------------------ 1 file changed, 131 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 43a0b33..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,131 +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._ - From 2819433fdcee51050112fa6b776b7c00f9a1d8fa Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 19:51:23 +0530 Subject: [PATCH 3/8] refactor: Remove SECURITY.md --- SECURITY.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 7890fe5..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,9 +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 af5e1dfd5684b22be5c86349a50c9db0dc00eba1 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 19:53:45 +0530 Subject: [PATCH 4/8] fix: broken URL --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index f094248..61b3855 100644 --- a/profile/README.md +++ b/profile/README.md @@ -7,7 +7,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 From 9440f74c541ee49724f5e0e12d326d15b474e3d9 Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 19:56:00 +0530 Subject: [PATCH 5/8] fix: more broken links --- profile/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/profile/README.md b/profile/README.md index 61b3855..4f97824 100644 --- a/profile/README.md +++ b/profile/README.md @@ -34,7 +34,7 @@ Note: high version can still run, but are not guaranteed offically. > > 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/.github/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/.github/blob/main/LICENSE.txt). +By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt). ## Community & Discussions @@ -45,4 +45,4 @@ You can ask or discuss casually on our [telegram community](https://t.me/passcod ## Licence -Passcodes Project is license under [MIT](https://github.com/PasscodesApp/.github/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. +Passcodes Project is license under [MIT](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt) License. Downloading the app would mean, you are okay and have accepted the license. From 2ab02616a601da6eefbc9475e43f759f73c6f6dd Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 20:01:29 +0530 Subject: [PATCH 6/8] feat: add a documentation section.. --- profile/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/profile/README.md b/profile/README.md index 4f97824..2971004 100644 --- a/profile/README.md +++ b/profile/README.md @@ -24,6 +24,10 @@ Android 14 [API level 34] (we support offically) Note: high version can still run, but are not guaranteed offically. ``` +## Documentation & Help Wanted + +For developers or support docs, checkot our [documentation repository](https://github.com/PasscodesApp/Passcodes-Docs) or reach out to us on [telegram community](https://t.me/passcodescommunity)... + ## Contribution Are Appreciated!!! > [!IMPORTANT] From 35f9d1e6ba4c4665706696af89b5cf6cf1f14abd Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 17 Sep 2025 20:03:39 +0530 Subject: [PATCH 7/8] fix: typos --- profile/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 2971004..69e7c66 100644 --- a/profile/README.md +++ b/profile/README.md @@ -26,7 +26,9 @@ Note: high version can still run, but are not guaranteed offically. ## Documentation & Help Wanted -For developers or support docs, checkot our [documentation repository](https://github.com/PasscodesApp/Passcodes-Docs) or reach out to us on [telegram community](https://t.me/passcodescommunity)... +For developers or support docs, checkout our [documentation repository](https://github.com/PasscodesApp/Passcodes-Docs). + +you can also reach out to us on our [telegram community](https://t.me/passcodescommunity)... ## Contribution Are Appreciated!!! From 3474221f7545dc1247afec3422546bcf7be4f9ed Mon Sep 17 00:00:00 2001 From: Jeel Dobariya <136002730+JeelDobariya38@users.noreply.github.com> Date: Wed, 24 Sep 2025 22:36:52 +0530 Subject: [PATCH 8/8] docs: Update README.md --- profile/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/profile/README.md b/profile/README.md index 69e7c66..aebe645 100644 --- a/profile/README.md +++ b/profile/README.md @@ -39,8 +39,12 @@ you can also reach out to us on our [telegram community](https://t.me/passcodesc > 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). -By, contributing to project you accept the [CONTRIBUTING.md](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/CONTRIBUTING.md) & [MIT License](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/LICENSE.txt). +And also have look at [Open Contributing Timeline](https://github.com/PasscodesApp/Passcodes-Docs/blob/main/other-docs/open-contributing-timeline.md). ## Community & Discussions @@ -49,6 +53,10 @@ You can ask or discuss casually on our [telegram community](https://t.me/passcod > [!IMPORTANT] > Also consider our telegram community as single source of truth in any situation.. so please join there!! because other link of website or of github repository might change over time... -## Licence +## Security Policy + +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 the app would mean, you are okay and have accepted the license. +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.