Skip to content

Commit

Permalink
doc: Prepare repository (part 1) (#3)
Browse files Browse the repository at this point in the history
Closes #1
  • Loading branch information
Gashmob authored Jul 14, 2024
2 parents 69009b4 + 6e6fb43 commit 4eaa17a
Show file tree
Hide file tree
Showing 10 changed files with 317 additions and 2 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/1_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Bug report
description: Fill a bug report
labels: [ "bug" ]
body:
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the problem
validations:
required: true
- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce
description: Tell us how we can reproduce the bug, it's the best way to help us to fix it.
validations:
required: true
- type: textarea
id: possible-solution
attributes:
label: Possible solution
description: "Optional: if you have an idea how to fix it, don't hesitate to also open a pull request"
- type: textarea
id: additional-context
attributes:
label: Additional context
description: "Optional: Add any other context about the problem here. Like your OS, C++ compiler, ..."
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/2_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Feature request
description: Suggest an idea for this project
labels: [ "enhancement" ]
body:
- type: textarea
id: description
attributes:
label: Description
description: A description of the new feature
validations:
required: true
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Describe your changes

[Part of|Closes] #<issue>

...


## Checklist before requesting a review

- [ ] I've followed Contributions guidelines
- [ ] I have performed a self-review of my code
- [ ] If it's a new feature, I've added tests that covers 100% of it
- [ ] If it's a bug fix, I've added test case to reproduce the bug
10 changes: 10 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
changelog:
categories:
- title: New Features 🎉
labels: [enhancement]
- title: Bug fixes 🛠
labels: [bug]
- title: Dependencies updates 🧰
labels: [dependencies]
- title: Other changes
labels: ["*"]
128 changes: 128 additions & 0 deletions 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
kevin@ktraini.com.
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.
81 changes: 81 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Contributing

First of all, thanks for taking time to contribute! ❤️

Anyone is welcome to contribute to this project. And if you not have time to contribute, don't worry. You can also :

- Star the project ⭐
- Mention the project to your friends/colleagues 🗣

## Code of conduct

The code of conduct is described in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).

## Issues

filc uses GitHub issues to track issues and development.

Before opening a new one, check that there is not an existing [issue](https://github.com/Fil-Language/filc/issues)
answering to your problem.

Then, you can open a [new issue](https://github.com/Fil-Language/filc/issues/new/choose) and choose the corresponding
template. Please ensure your description is clear and has sufficient details to be able to reproduce the issue.

## Contribute

Here is a small checklist:

- Open an issue to discuss the changes you want to make first
- Create a fork of this repository
- Make your changes
- Submit a pull request on top of `master` branch

### Submitting pull requests

Before we can merge your pull request, here are some guidelines you need to follow.

These guidelines help keeping the code clean, stable and easier to review.

**Principles**

- No dead code: If you create a function, it's to use it
- All functions, class, types should be as strictly as possible
- Comment, sometimes it's painful to comment, but it helps you and us to understand the code, improve it, maintain it

**Conventions**

C++ conventions and rules are all listed in `.clang-tidy` and `.clang-format` files. Modern IDEs all supports
formatting from these files. If you not use an IDE, please call `clang-tidy` as often as possible to keep your code
clear.

**Commits**

Please follow [Conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) guidelines for your commit message.
A [template](commit-template) is available, you can use by running `git config commit.template commit-template`.

All your commit *MUST* work. If your feature is too big to be in one commit, add exceptions, early returns to keep the
code working.

**Tests**

We try to keep our test coverage as high as possible. It means that everything *MUST* be tested.

If you submit a bug fix, add a test case reproducing the bug. If it's a new feature, add tests covering all code paths.

Testing code paths is not just the happy path, tests as many case as possible. This software needs to be stable.

**License**

By contributing to filc, you agree that your contributions will be licensed under the [LICENSE](LICENSE.md) file in the
root directory of this source tree.

Each file *MUST* begin with the license text.

**Pull request**

When submitting your pull request please follow the provided template. Our team will review your code as soon as
possible.

## Security

You can read more about how to report security issues in our [Security Policy](SECURITY.md).
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,33 @@
# filc

Fil compiler
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Version](version.svg)

[https://fil.ktraini.com](https://fil.ktraini.com)
Fil compiler: [https://fil.ktraini.com](https://fil.ktraini.com).

## Install

**TODO**

## Building

**TODO**

## Testing

**TODO**

## Contributing

You want to contribute, please read the [Code of conduct](CODE_OF_CONDUCT.md) and [Contributing](CONTRIBUTING.md).

## Security

Needed information is in [Security](SECURITY.md).

## Acknowledgements

Thanks to JetBrains for helping me develop this project by offering me
an [open source license](https://jb.gg/OpenSourceSupport)

![JetBrains Logo (Main) logo](https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.svg)
6 changes: 6 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Security Policy

If you discover a security vulnerability within filc, please go to
the [Security tab](https://github.com/Fil-Language/filc/security) of the repository to report it.

Please withhold public disclosure until after we have addressed the vulnerability.
9 changes: 9 additions & 0 deletions commit-template
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<type>: <title>

[Part of|Closes] #<issue>

<Why?>

*Testing:*

<how to test?>
1 change: 1 addition & 0 deletions version.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4eaa17a

Please sign in to comment.