Skip to content

Commit

Permalink
Made a basic version of the documentation website with code of coduct…
Browse files Browse the repository at this point in the history
… and contributing guidelines
  • Loading branch information
shreyaspranav committed Oct 27, 2024
1 parent 6625164 commit 92df499
Show file tree
Hide file tree
Showing 4 changed files with 223 additions and 3 deletions.
15 changes: 13 additions & 2 deletions docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
export default {
base: '/XenodeDevDocs/'
}
base: '/XenodeDevDocs/',

title: 'Xenode Dev Documentation',
themeConfig: {
nav: [
{ text: 'GitHub', link: 'https://github.com/XenodeStudio' },
],
sidebar: [
{ text: 'Contributing Guidelines', link: '/contributing.md' },
{ text: 'Code of Conduct', link: '/code_of_conduct.md' }
]
}
}
128 changes: 128 additions & 0 deletions docs/code_of_conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## 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, 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
.
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.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
71 changes: 71 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Contributing Guidelines

So you have decided to contribute to projects at **Xenode Studio**. Thank you for your interest in contributing to Xenode:tada: We welcome contributions from the community and appreciate your support in making our game engine better.

The following is a set of guidelines for contributing to the [Xenode Game Engine](https://github.com/XenodeStudio/Xenode) and other projects by [Xenode Studio](https://github.com/orgs/XenodeStudio/repositories).

::: warning
By participating to contribute to our projects, it is expected to uphold the [Code of Conduct](/code_of_conduct.md)
:::

::: tip
We use GitHub to manage our repositories. If you’re not familiar with git/GitHub, we strongly recommend following a tutorial, such as [this one](https://try.github.io).
:::

## Ways to contribute

Whether you are a developer, a designer, a game developer or a just like game engines in general, there are lots of ways to contribute. Here's a few ideas:

- _Try building and running Xenode on your local machine._ Does it work? Does it do what you'd expect? If not, open an [issue](https://github.com/XenodeStudio/Xenode/issues) and let us know.
- _Show some involvement on the project's open issues._ Have you experienced the same problem? Know a work around? Do you have a suggestion for how the feature could be better?
- _Read through the documentation, and ask the community_, any time you see something confusing, or have a suggestion for something that could be improved.
- _Find an open issue_ (especially those labeled **help wanted/good first issue**), _mention yourself in the comment with the interest to work on the issue and submit a proposed fix._ If it’s your first pull request, we promise we won’t bite, and are glad to answer any questions.
- _Help evaluate open pull requests,_ by testing the changes locally and reviewing what’s proposed.
- _Open an issue if you found something that needs a fix_ **(Please don’t forget to mention if you want to work on the issue you opened or have started working for a fix!)**

## Contributing the source code

::: warning
- Before you start working on an issue, kindly ensure that no one else is already working on the issue.
- If nobody is working on that issue, drop a comment to let everyone know that you will be working on the issue.
:::

### Prepare your working tree.

1. [Click here](https://github.com/XenodeStudio/Xenode) to open the source code of Xenode in Github.
2. Fork the project by clicking on "Fork" on the top right corner area.
3. Clone the repository locally
``` shell
git clone --recursive https://github.com/<your-username>/Xenode
```
4. Create a new, descriptively named branch to contain you code changes.
``` shell
git checkout -b my-new-branch-that-does-this
```


### Obtain the source code and build.

[Click here]() to obtain instructions to build Xenode.

### Making Code Changes.

Now that you've successfully built Xenode from source, hack your way into the source code. Just make sure to:
- Follow the code style used in the module you are contributing to.
- before committing and pushing the changes, test the code both manually and automatically with the automated test suite if applicable.

### Submitting a Pull Request(PR)

Follow the following to steps to raise a PR:
- Navigate to your fork on GitHub and open the Pull Requests tab.
- Create a new Pull Request.
- Select the **base** and **compare** branches.
- Fill out the PR form.
- Write a title and description for your pull request. Be clear about what changes you made and why.
- Submit the Pull Request by clicking the "Create Pull Request" button.

## Thank You:heart:

If you follow these guidelines closely your contribution will have a very positive impact on the Xenode Project.

Thanks a lot for your patience.
12 changes: 11 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# Welcome to Xenode Developer Documentation!

This is where the developer documentation is hosted. Built in VitePress.
We are thrilled to welcome you to the **Xenode Developer Documentation!** This is your comprehensive resource for understanding and utilizing the Xenode game engine, a tool designed to empower game developers of all levels.

## Contributing to Xenode

If you are interested in contributing to the **Xenode** game engine or any other projects within **Xenode Studio**, we encourage you to do so! Your contributions play a vital role in enhancing our platform and fostering a vibrant community of developers.

## Important Guidelines
Before you start, please take a moment to review our [Contributing Guidelines](/contributing.md). These guidelines outline how you can effectively contribute and collaborate with our team, ensuring a smooth and productive process for everyone involved.

Thank you for being a part of the Xenode Studio community. Together, we can create innovative and exciting gaming experiences!

0 comments on commit 92df499

Please sign in to comment.