Contributor guide creation (#111)

* Added guides

* Added AI policy

* Updated root directory markdown URLs

Author: palisadoes

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
 # Contributor Covenant Code of Conduct
 
-Please read our Organization's [Contributor Covenant Code of Conduct](https://github.com/PalisadoesFoundation/.github/blob/main/profile/CODE_OF_CONDUCT.md).
+Please read our Organization's [Contributor Covenant Code of Conduct](https://developer.palisadoes.org/docs/contributor-guide/code-of-conduct).

CONTRIBUTING.md

@@ -1,98 +1,3 @@
 # Contributing to our Project
 
-Thank you for your interest in contributing to our project. Regardless of the size of the contribution you make, all contributions are welcome and are appreciated.
-
-If you are new to contributing to open source, please read the Open Source Guides on [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/).
-
-## Ways to Contribute
-
-We know you are ready to start contributing code right away! Hers is a list of [good first issues](https://github.com/PalisadoesFoundation/developer-docs/labels/good%20first%20issue) that contain issues with a limited scope.
-
-## Quicklinks
-
-- [Contributing to our Project](#contributing-to-our-project)
-  - [Ways to Contribute](#ways-to-contribute)
-  - [Quicklinks](#quicklinks)
-    - [Our Development Process](#our-development-process)
-      - [Issues](#issues)
-      - [Pull Requests](#pull-requests)
-      - [Git Flow](#git-flow)
-    - [Contributing Code](#contributing-code)
-    - [Who Can Contribute](#who-can-contribute)
-    - [Internships](#internships)
-  - [Community](#community)
-
-### Our Development Process
-
-We utilize GitHub issues and pull requests to keep track of issues and contributions from the community.
-
-#### Issues
-
-Make sure you are following [issue report guidelines](ISSUE_GUIDELINES.md) available here before creating any new issues to the project.
-
-#### Pull Requests
-
-[Pull Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on open issues.
-
-#### Git Flow
-
-For this project, we utilize the GitFlow branching model. GitFlow is geared towards efficiently tracking development and managing releases. The model makes parallel development efforts easy and safe by isolating new development efforts from completed work.
-
-The different types of branches we may use are:
-
-- Feature branches (feature/branch-name)
-- Release branches (release/1.XX)
-- Bug branches (bugfix/branch-name)
-- Hotfix branches (hotfix/branch-name)
-
-Detailed document containing how GitFlow works: https://nvie.com/posts/a-successful-git-branching-model/
-
-### Contributing Code
-
-Code contributions to this project come in the form of pull requests. These are done by forking the repo and making changes locally.
-
-Make sure you have read the [Documentation for Setting up the Project](https://github.com/PalisadoesFoundation/developer-docs#readme)
-
-The process of proposing a change to this project can be summarized as:
-
-1. Fork the project repository and branch off `master`.
-2. The repository can be cloned locally using `git clone <forked repo url>`.
-3. Make the desired changes to the project source code.
-4. Run the website and test your changes.
-5. If you've added code that should be tested, write tests.
-6. After making changes you can add them to git locally using `git add <file_name>`(to add changes only in a particular file) or `git add .` (to add all changes).
-7. After adding the changes you need to commit them using `git commit -m '<commit message>'`(look at the commit guidelines below for commit messages).
-8. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.)
-9. Now create a pull request to the project repository from your forked repo. Open an issue regarding the same and link your PR to it.
-10. Ensure the test suite passes, either locally or on CI once a PR has been created.
-11. Review and address comments on your pull request if requested.
-
-### Who Can Contribute
-
-Unfortunately, because of recent abuse, we will only be assigning issues to persons who have:
-
-1. At least a year of GitHub history
-1. Consistent code updates throughout their GitHub life, especially the most recent 12 months.
-
-This is a new policy triggered by newly created accounts that:
-
-1. Use automation to blindly submit and update pull requests.
-1. SPAM our volunteers to be assigned issues to the exclusion of others.
-1. Frequently abandon issues after being assigned.
-1. Frequently close pull requests with ratios of merged to closed PRs approaching 10:1
-1. Repeatedly ignore PR requested changes from reviewers
-1. Resolve Code Rabbit suggestions without implementing them.
-1. Use AI to generate generic plans of action without an in-depth knowledge of the code base. This is not helpful for us.
-
-As expected, we need contributors who are interested in coding with a proven track record. This is an unfortunate development but the recent abuse of the system has given us no choice.
-
-### Internships
-
-If you are participating in any of the various internship programs we ar members of then please read the [internship introduction guides](https://developer.palisadoes.org/docs/category/internships).
-
-## Community
-
-There are many ways to communicate with the community.
-
-1. The Palisadoes Foundation has a Slack channel where members can assist with support and clarification. Visit the [Palisadoes Foundation's GitHub repository home page](https://github.com/PalisadoesFoundation) for the link to join our slack channel.
-2. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.
+Please read our Organization's [Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing).

ISSUE_GUIDELINES.md

@@ -1,4 +1,3 @@
 # Issue Reporting Guidelines
 
-Please read our Organization's [Issue Reporting Guidelines](https://github.com/PalisadoesFoundation/.github/blob/main/profile/ISSUE_GUIDELINES.md).
-
+Please read our Organization's [Issue Reporting Guidelines](https://developer.palisadoes.org/docs/contributor-guide/issues).

PR_GUIDELINES.md

@@ -1,3 +1,3 @@
 # Pull Request Guidelines
 
-Please read our [General PR Guidelines](https://github.com/PalisadoesFoundation/.github/blob/main/profile/PR_GUIDELINES.md) first.
+Please read our Organization's [Contributing Guidelines](https://developer.palisadoes.org/docs/contributor-guide/contributing).

docs/contributor-guide/ai.md

@@ -0,0 +1,80 @@
+---
+id: ai
+title: AI Use Policy
+sidebar_position: 15
+---
+
+Our goal in our projects is to develop an excellent software system. This requires careful attention to detail in every change we integrate. Maintainer time and attention is very limited, so it's important that changes you ask us to review represent your _best_ work.
+
+## AI-Assisted Contributions
+
+You are encouraged to use tools that help you write good code, including AI tools. Keep the following points in mind:
+
+1. The PR author should understand the core ideas behind the implementation end-to-end, and be able to justify the design and code during review whether or not you used an LLM as part of your process to produce them. The answer to "Why did you make change X?" should never be "I'm not sure. The AI did it."
+
+2. **Calls out unknowns and assumptions.** It’s okay to not fully understand some bits of AI generated code. You should comment on these cases and point them out to reviewers so that they can use their knowledge of the codebase to clear up any concerns. For example, you might comment "calling this function here seems to work but I’m not familiar with how it works internally, I wonder if there’s a race condition if it is called concurrently".
+
+## Why fully AI-generated PRs without understanding are not helpful
+
+Today, AI tools cannot reliably make complex changes to our code on their own, which is why we rely on pull requests and code review.
+
+The purposes of code review are to:
+
+1. Finish the intended task.
+
+1. Share knowledge between authors and reviewers, as a long-term investment in the project. For this reason, even if someone familiar with the codebase can finish a task quickly, we’re still happy to help a new contributor work on it even if it takes longer.
+
+An AI dump for an issue doesn’t meet these purposes. Maintainers could finish the task faster by using AI directly, and the submitters gain little knowledge if they act only as a pass through AI proxy without understanding.
+
+Please understand the reviewing capacity is very limited for our projects therefore:
+
+1. PRs which appear to not have the requisite understanding, or violate these guidelines might not get reviewed, and may eventually closed or redirected.
+
+2. Repeated violations of this policy will be handled by our [Code of Conduct](./code-of-conduct.md) policy.
+
+## Using AI as a coding assistant
+
+1. Don't skip **becoming familiar with the part of the codebase** you're working on. This will let you write better prompts and validate their output if you use an LLM. Code assistants can be a useful search engine/discovery tool in this process, but don't trust claims they make about how our projects work. LLMs are often wrong, even about details that are clearly answered in our documentation.
+
+2. Split up your changes into **[coherent commits]**, even if an LLM generates them all in one go.
+
+3. Don't simply ask an LLM to add **code comments**, as it will likely produce a bunch of text that unnecessarily explains what's already clear from the code. If using an LLM to generate comments, be really specific in your request, demand succinctness, and carefully edit the result.
+
+## Using AI for communication
+
+As noted above, our contributors are expected to communicate with intention, to avoid wasting maintainer time with long, sloppy writing. We strongly prefer clear and concise communication about points that actually require discussion over long AI-generated comments.
+
+When you use an LLM to write a message for you, it remains **your responsibility** to read through the whole thing and make sure that it makes sense to you and represents your ideas concisely. A good rule of thumb is that if you can't make yourself carefully read some LLM output that you generated, nobody else wants to read it either.
+
+Here are some concrete guidelines for using LLMs as part of your communication
+workflows.
+
+1. When writing a pull request description, **do not include anything that's obvious** from looking at your changes directly (e.g., files changed, functions updated, etc.). Instead, focus on the _why_ behind your changes. Don't ask an LLM to generate a PR description on your behalf based on your code changes, as it will simply regurgitate the information that's already there.
+
+1. Similarly, when responding to a pull request comment, **explain your reasoning**. Don't prompt an LLM to re-describe what can already be seen from the code.
+
+1. Verify that **everything you write is accurate**, whether or not an LLM generated any part of it. Our maintainers will be unable to review your contributions if you misrepresent your work (e.g., misdescribing your code changes, their effect, or your testing process).
+
+1. Complete all parts of the **PR template**, including screenshots and the self-review checklist. Don't simply overwrite the template with LLM output.
+
+1. **Clarity and succinctness** are much more important than perfect grammar, so you shouldn't feel obliged to pass your writing through an LLM. If you do ask an LLM to clean up your writing style, be sure it does _not_ make it longer in the process. Demand succinctness in your prompt.
+
+1. Quoting an LLM answer is usually less helpful than linking to **relevant primary sources**, like source code, reference documentation, or web standards. If you do need to quote an LLM answer in a conversation, put the answer in a **quote block** to distinguish LLM output from your own thoughts.
+
+1. It’s recommended to write a high-quality issue with a clear problem statement and a minimal, reproducible example. This can make it easier for others to contribute.
+
+## Unwelcome Repository Contributions
+
+We do not welcome the following activities that are often the result of AI automations:
+
+1. Using automation to blindly submit and update pull requests.
+2. Frequent closing of pull requests for the same issue.
+3. Repeatedly ignoring PR requested changes from reviewers and automated systems.
+   1. This includes resolving requested changes without modifying code.
+4. Repeatedly ignoring answering any questions from reviewers.
+5. Using AI to generate generic plans of action without an in-depth knowledge of the code base. This is not helpful for us.
+6. Deleting all comments in the submitted edited files.
+7. Repeatedly submitting irrelevant files for PR review after being made aware of the practice.
+8. Repeatedly dismissing or resolving reviewer suggestions without modifying code.
+
+Persons who violate our expectations listed above will be referred to our [Code of Conduct process](./code-of-conduct.md).

docs/contributor-guide/code-of-conduct.md

@@ -0,0 +1,138 @@
+---
+id: code-of-conduct
+title: Code of Conduct
+sidebar_position: 100
+---
+
+Welcome to our Code of Conduct Policy page.
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [The Palisadoes Foundation](http://www.palisadoes.org/)
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available
+at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

docs/contributor-guide/introduction.md

@@ -0,0 +1,31 @@
+---
+id: introduction
+title: Introduction
+sidebar_position: 10
+---
+
+Here are some general guidelines to help you get started.
+
+### Code of Conduct
+
+A safe environment is required for everyone to contribute. Read our [Code of Conduct Guide](code-of-conduct.md) to understand what this means. Let us know immediately if you have unacceptable experiences in this area.
+
+No one should fear voicing their opinion. Respones must be respectful.
+
+### Video Guides
+
+We have lots of video resources about our projects.
+
+1. Visit our [YouTube Channel playlists](https://www.youtube.com/@PalisadoesOrganization/playlists) for more insights
+1. The "[Getting Started - Developers](https://www.youtube.com/watch?v=YpBUoHxEeyg&list=PLv50qHwThlJUIzscg9a80a9-HmAlmUdCF&index=1)" videos are extremely helpful for new open source contributors.
+
+These will help you get started quicker.
+
+### Our Community
+
+There are many ways to participate in our community.
+
+1. Join our [community forum](https://community.talawa.io) and introduce yourself. There are many persons on the various forums who are willing to assist you in getting started.
+1. We also have a technical email list run by [freelists.org](https://www.freelists.org/). Search for "palisadoes" and join. Members on this list are also periodically added to our marketing email list that focuses on less technical aspects of our work.
+
+We look forward to hearing from you.