This document explains how to contribute changes to Freedomcraft Wiki.
Sensitive security-related issues should be reported to security@freedomcraft.email.
For setting up a Personal Vault see Obsidian.md Community Hub
To contribute, please make a fork of this repository, clone your Forked Repo locally and open it in Obsidian. This is important to avoid duplicating content, and allows you to use the autocomplete when linking to other notes, searching and following our content guidelines.
Because Personal Knowledge Management is usually (as it name states) highly personal, we have added a few rules about how we use Obsidian features to keep this Community vault consistent (and to preserve our sanity 🙂)
-
Files & Links: Make sure that any time you add or edit a note, your settings are configured correctly. This should be set up by default. To sum up:
- Configure
Location of new notesto go the [[Inbox/🗂️ New Notes - Overview|🗂️ Inbox]] folder. - Links should be set to
Relative Pathsand wiki links must be enabled. - The
Default location for new attachmentsshould be the folder [./assets/] - Example: [
]
- Configure
-
Folders: We have roughly pre-defined the structure of the vault. Before adding new folders, please open an issue to discuss the changes you'd like to propose.
Now that you have configured Obsidian, you are ready to do your first contribution! Have a look at the [[Knowledgebase/Guidelines/Contributing Guidelines/Types of Contributions|Types of Contributions]], and depending on what you want to contribute open the linked note for further instructions.
Once you have added or edited the note using Obsidian, come back and check out [[Knowledgebase/Guidelines/Contributing Guidelines/Submitting your Contribution|Submitting your Contribution]].
Please search the issues on the issue tracker with a variety of keywords to ensure your bug is not already reported.
If unique, open an issue.
Please write clear, concise instructions so we can reproduce the behavior— even if it seems obvious. The more detailed and specific you are, the faster we can fix the issue.
Please be kind, remember that your fellow FreedomCraft Staff work as volunteers.
The project welcomes submissions. If you want to change or add something, please let everyone know what you're working on—file an issue! Significant changes must go through the change proposal process before they can be accepted. To create a proposal, file an issue with your proposed changes documented, and make sure to add the label "proposal".
This process gives everyone a chance to validate the design, helps prevent duplication of effort, and ensures that the idea fits inside the goals for the project and tools. It also checks that the design is sound before code is written; the code review tool is not the place for high-level discussions.
Changes to Freedomcraft Wiki must be reviewed before they are accepted—unless they are an owner or a maintainer. We use GitHub's pull request & review workflow to do that. GitHub ensures every PR is reviewed by at least 1 maintainer.
Please try to make your pull request easy to review for us.
- Make small pull requests. The smaller, the faster to review and the more likely it will be merged soon.
- Don't make changes unrelated to your PR. Maybe there are typos on some comments, maybe refactoring would be welcome on a function... but if that is not related to your PR, please make another PR for that.
- Split big pull requests into multiple small ones. An incremental change will be faster to review than a huge PR.
Before we reach v1 there is no fixed release cycle.
This repo is part of the FreedomCraft Project and as such, all contributions are part of that project's governance.