docs: add contributing guide and update references#4
Open
itwaasyou wants to merge 1 commit intoprotonpass:mainfrom
Open
docs: add contributing guide and update references#4itwaasyou wants to merge 1 commit intoprotonpass:mainfrom
itwaasyou wants to merge 1 commit intoprotonpass:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a dedicated Contributing guide to the documentation. It brings together key information developers need like enabling debug logging and configuring the filesystem key provider into one easy-to-find place.
Motivation
Right now, important setup details (such as
PROTON_PASS_KEY_PROVIDER=fsandPASS_LOG_LEVEL) are spread across the Configuration and Troubleshooting pages. That makes onboarding a bit harder than it needs to be.By creating a dedicated Contributing guide, new contributors can quickly get their development environment up and running without having to dig through multiple sections of the docs.
Changes
docs/public/docs/help/contributing.mdwith development workflow and testing instructions.docs/public/docs/index.mdto include a link to the Contributing guide in the Quick start section.docs/public/docs/help/faq.mdwith a new “How can I contribute?” entry linking to the guide.