First off, thanks for taking the time to contribute! 🎉 Make sure you follow below guidelines before contributing.
You need to have the follow tools installed:
Once installed you can verify if the software are working properly or not by invoking the following commands;
# Verify the mdbook CLI tool is installed on your system
mdbook --version
# Example output: mdbook v0.4.21
-
Fork the repository & clone it on your local machine:
git clone github.com/developersIndia/wiki
-
Run the development server to see the changes live:
mdbook serve
- Questions that are repeatedly asked on our subreddit (or discord). E.g "How to prepare yourself for a product job" or "How to switch from service based to a product-based job".
- FAQs are highly valuable to the community & we expect you to constantly update them as time changes.
- While adding insightful posts & comments from the community, make sure you
follow below guidelines:
- Follow the pattern of the existing FAQs.
- Always make sure the content is relevant to the topic. If a category for FAQs doesn't exist, create a proposal with the necessary posts/comments that can belong to it.
- Always make sure the content is not offensive. If moderators have removed a post, avoid linking any content from it.
- Avoid linking any comments that are "reactions" to the post (E.g. congrats OP, I'm in same situation, etc).
- Avoid linking any comments that are "follow-up" questions to a post. Only link direct answers to the post.
- Add comments that are are insightful, these usually have a lot of upvotes or 1-2 paragraphs or points of detailed advice.
- Long text guides which will help developersIndia (or the tech community) in general. You can suggest ideas by creating a proposal. A nice example would be "How to improve your productivity as a developer". Go very niche with the topic.
- Basically these are guides that are not FAQs but are still very helpful to the community. Avoid proposing tutorials, like how to create a HTMX app.
- Try to make you wiki as detailed as possible. We don't expect you to know everything.
- Your intention while writing a wiki should be to think of the community as a whole.
- Try to avoid any personal opinions. Try to be as close as possible towards facts.
- You create a wiki proposal with an intention to work on it.
- Community Members review your proposal & ask/suggest any follow ups.
- You take your time to write this wiki. We use markdown for writing and vale for prose linting.
- You create a PR mentioning the issue no.
- One (or more) community members from our team reviews your Wiki. You fix any issues (grammar etc)
- Once the PR is merged. We announce the new wiki addition on our subreddit (and discord).