Skip to content

Commit

Permalink
add - Added CoC and updated index.md
Browse files Browse the repository at this point in the history
---

We've added code of conduct and updated the index.md for each project so that these files become more relevant.

---

Type: add
Breaking: False
Doc Required: False
Backport Required: False
Part: 1/1
  • Loading branch information
AptiviCEO committed Sep 28, 2024
1 parent 44bd229 commit 7069c16
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 11 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, 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.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers 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, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at eoflaoevicecity AT gmail DOT com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

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

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
16 changes: 5 additions & 11 deletions DocGen/index.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
## What is Terminaux?

Terminaux is a library that allows you to manipulate with the console.

## What is this web page?

This webpage is an API documentation for mod developers to be used as reference. It constantly gets updated as we push the updates to the main and servicing versions of this project.
This webpage is an API documentation for developers to be used as reference. It constantly gets updated as we push new versions and new APIs, as well as updated documentation. If your IDE supports Intellisense, you don't need to open this web page.

If you still intend to use a documentation specific to your preferred version of Terminaux, you may refer to the [releases](https://github.com/Aptivi/Terminaux/releases) page of the project and download the attached `<version>-doc.zip` file.
If you still intend to use a documentation specific to your preferred version, you may refer to the [releases](https://github.com/Aptivi/BassBoom/releases) page of the project and download the attached `<version>-doc.zip` file.

To get started using the documentation, select `API Documentation` from the top menu and select a namespace to get a clear overview of the API.

## Feedback

If you wish to leave feedback to us about this API reference website, use the [issue tracker](https://github.com/Aptivi/Terminaux/issues) of the project.

If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/Terminaux/pulls); we don't support override files that are made by clicking on `Improve this doc`.
If you wish to leave feedback to us about this API reference website, use the [issue tracker](https://github.com/Aptivi/BassBoom/issues) of the project.

Any meaningful contributions are welcome.
If you wish to contribute to the documentation of the API, go to the project source code and make your improvements there on a draft [Pull Request](https://github.com/Aptivi/BassBoom/pulls); we don't support override files that are made by clicking on `Improve this doc`.

Copyright (c) 2022-2023 Aptivi. All rights reserved.
Any meaningful contributions are welcome, as long as they follow the [code on conduct](https://github.com/Aptivi/BassBoom/blob/main/CODE_OF_CONDUCT.md) and [contribution guidelines](https://github.com/Aptivi/BassBoom/blob/main/CONTRIBUTING.md).

0 comments on commit 7069c16

Please sign in to comment.