This commit is contained in:
Captain Nick Lucifer* 2023-03-06 20:39:08 +05:45
commit 3ce28c614d
7 changed files with 427 additions and 0 deletions

85
docs/CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,85 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make 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
* Spam
* Public or private "harassment" as including the definition in the
[Citizen Code of Conduct](https://web.archive.org/web/20200330154000/http://citizencodeofconduct.org/); if you have
any lack of clarity about what might be included in that concept, please
read their definition.
* 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 within all project spaces, and it also applies
when an individual is representing the project or its community in public
spaces.
Examples of representing a project or community include using an official
project email 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 maintainer using any of the
[private contact addresses](https://gitdab.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator#support).
All complaints will be reviewed, 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](https://www.contributor-covenant.org), version 1.4,
available at
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>.
For answers to common questions about this code of conduct, see
<https://www.contributor-covenant.org/faq>.

90
docs/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,90 @@
# Contributing
When contributing to this repository, please first discuss the change you
wish to make via issue, email, or any other method with the owners of this
repository before making a change.
Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it
in all your interactions with the project.
## Request for contributions
Please contribute to this repository if any of the following is true:
- You have expertise in community development, communication, or education
- You want open source communities to be more collaborative and inclusive
- You want to help lower the burden to first time contributors
## Contributions
Prerequisites:
- Familiarity with
[pull requests](https://help.github.com/articles/using-pull-requests) and
[issues](https://guides.github.com/features/issues/).
- Knowledge of [Markdown](https://help.github.com/articles/markdown-basics/)
for editing `.md` documents.
In particular, this community seeks the following types of contributions:
- **Ideas**: participate in an issue thread or start your own to have your
voice heard.
- **Resources**: submit a pull request to add to
[RESOURCES.md](docs/RESOURCES.md) with links to related content.
- **Outline sections**: help us ensure that this repository is comprehensive.
If there is a topic that is overlooked, please add it, even if it is just
a stub in the form of a header and single sentence.
Initially, most things fall into this category.
- **Writing**: contribute your expertise in an area by helping us expand the
included content.
- **Copy editing**: fix typos, clarify language, and generally improve the
quality of the content.
- **Formatting**: help keep content easy to read with consistent formatting.
## Development environment setup
> **[?]**
> Proceed to describe how to setup local development environment.
> e.g:
To set up a development environment, please follow these steps:
1. Clone the repo
```sh
git clone https://github.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator
```
2. TODO
## Issues and feature requests
Have you found a bug in the source code, a mistake in the documentation, or
maybe you'd like a new feature?
You can help us by
[submitting an issue](https://gitdab.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator/issues).
Before you create an issue, make sure to search the issue archive -- your
issue may have already been addressed!
Please try to create bug reports that are:
- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Unique._ Do not duplicate existing opened issues.
- _Scoped to a Single Bug._ One bug per report.
**Even better: Submit a pull request with a fix or new feature!**
### How to submit a Pull Request
1. Search our repository for open or closed
[Pull Requests](https://gitdab.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator/pulls)
that relate to your submission.
You don't want to duplicate effort.
2. Fork the project.
3. Create your feature branch (`git checkout -b feat/amazing_feature`).
4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) uses
[conventional commits](https://www.conventionalcommits.org), so please
follow the specification in your commit messages.
5. Push to the branch (`git push origin feat/amazing_feature`)
6. [Open a Pull Request](https://gitdab.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator/compare)

0
docs/RESOURCES.md Normal file
View file

16
docs/SECURITY.md Normal file
View file

@ -0,0 +1,16 @@
# Security Policy
## Reporting a Vulnerability
If there are any vulnerabilities in **CopunCodeGenerator**, don't hesitate to _report them_.
1. Use any of the [private contact addresses](https://gitdab.com/WeirdButCoolANDokTokenGenerator/CopunCodeGenerator#support).
2. Describe the vulnerability.
If you have a fix, that is most welcome -- please attach or summarize it in your message!
3. We will evaluate the vulnerability and, if necessary, release a fix or mitigating steps to address it. We will contact you to let you know the outcome, and will credit you in the report.
Please **do not disclose the vulnerability publicly** until a fix is released!
4. Once we have either a) published a fix, or b) declined to address the vulnerability for whatever reason, you are free to publicly disclose it.

BIN
docs/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB