diff --git a/.all-contributorsrc b/.all-contributorsrc index dc97e047b..17a9b4b33 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -3,7 +3,9 @@ "projectOwner": "sayajin-labs", "repoType": "github", "repoHost": "https://github.com", - "files": ["README.md"], + "files": [ + "README.md" + ], "imageSize": 100, "commit": true, "commitConvention": "gitmoji", @@ -13,31 +15,42 @@ "name": "Abdel @ StarkWare ", "avatar_url": "https://avatars.githubusercontent.com/u/45264458?v=4", "profile": "https://github.com/abdelhamidbakhta", - "contributions": ["code"] + "contributions": [ + "code" + ] }, { "login": "jobez", "name": "johann bestowrous", "avatar_url": "https://avatars.githubusercontent.com/u/615197?v=4", "profile": "https://github.com/jobez", - "contributions": ["code"] + "contributions": [ + "code" + ] }, { "login": "Eikix", "name": "Elias Tazartes", "avatar_url": "https://avatars.githubusercontent.com/u/66871571?v=4", "profile": "https://github.com/Eikix", - "contributions": ["review", "tutorial", "talk"] + "contributions": [ + "review", + "tutorial", + "talk" + ] }, { "login": "enitrat", "name": "Mathieu", "avatar_url": "https://avatars.githubusercontent.com/u/60658558?v=4", "profile": "https://github.com/enitrat", - "contributions": ["code", "test", "doc"] + "contributions": [ + "code", + "test", + "doc" + ] } ], "contributorsPerLine": 7, "linkToUsage": true } - diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 0956e759b..f5bcd1a3b 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1,3 @@ * @abdelhamidbakhta +* @Eikix +* @ClementWalter diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f24c0071c..421bef600 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -9,6 +9,7 @@ jobs: - uses: actions/checkout@v3 - uses: software-mansion/setup-scarb@v1 with: - scarb-version: '0.5.2' + scarb-version: "0.5.2" - run: scarb fmt --check + - run: scarb build - run: scarb test diff --git a/docs/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md index df641a16e..87324b14f 100644 --- a/docs/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -2,44 +2,77 @@ ## 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. +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: +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 +- 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 +- 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 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. +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. +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://github.com/sayajin-labs/kakarot-ssj#support). 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. +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project maintainer using any of the +[private contact addresses](https://github.com/sayajin-labs/kakarot-ssj#support). +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. +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 +This Code of Conduct is adapted from the +[Contributor Covenant](https://www.contributor-covenant.org), version 1.4, +available at + -For answers to common questions about this code of conduct, see +For answers to common questions about this code of conduct, see + diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index d882334d0..b42aaf790 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,32 +1,33 @@ # 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. +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. ## Development environment setup -> **[?]** -> Proceed to describe how to setup local development environment. -> e.g: +> **[?]** 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/sayajin-labs/kakarot-ssj - ``` - -2. TODO +To set up a development environment, please follow the steps from +[the README.md](../README.md#installation). ## Issues and feature requests -You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature?Take a look at [GitHub Discussions](https://github.com/sayajin-labs/kakarot-ssj/discussions) to see if it's already being discussed. You can help us by [submitting an issue on GitHub](https://github.com/sayajin-labs/kakarot-ssj/issues). Before you create an issue, make sure to search the issue archive -- your issue may have already been addressed! +You've found a bug in the source code, a mistake in the documentation or maybe +you'd like a new feature?Take a look at +[GitHub Discussions](https://github.com/sayajin-labs/kakarot-ssj/discussions) to +see if it's already being discussed. You can help us by +[submitting an issue on GitHub](https://github.com/sayajin-labs/kakarot-ssj/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. +- _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. @@ -35,10 +36,10 @@ Please try to create bug reports that are: ### How to submit a Pull Request 1. Search our repository for open or closed - [Pull Requests](https://github.com/sayajin-labs/kakarot-ssj/pulls) - that relate to your submission. You don't want to duplicate effort. + [Pull Requests](https://github.com/sayajin-labs/kakarot-ssj/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'`) +4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) 5. Push to the branch (`git push origin feat/amazing_feature`) 6. [Open a Pull Request](https://github.com/sayajin-labs/kakarot-ssj/compare?expand=1) diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 05edea948..1882c7e51 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -2,15 +2,22 @@ ## Reporting a Vulnerability -If there are any vulnerabilities in **Kakarot**, don't hesitate to _report them_. +If there are any vulnerabilities in **Kakarot**, don't hesitate to _report +them_. -1. Use any of the [private contact addresses](https://github.com/sayajin-labs/kakarot-ssj#support). +1. Use any of the + [private contact addresses](https://github.com/sayajin-labs/kakarot-ssj#support). 2. Describe the vulnerability. - If you have a fix, that is most welcome -- please attach or summarize it in your message! + 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. +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! + 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. +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.