Origins Sale

.solcover.js

@@ -1,3 +1,3 @@
 module.exports = {
-	skipFiles: ["Sovryn", "Openzeppelin", "Interfaces"],
+	skipFiles: ["Sovryn/Helper", "Sovryn/Mockup", "Sovryn/RSK", "Interfaces"],
 };

CODE_OF_CONDUCT.md

@@ -0,0 +1,45 @@
+# Contributor 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 [email protected].
+
+All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
+
+The project contributors are 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.

CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing
+
+Help is always welcome and there are plenty of options how you can contribute to Sovryn Origins.
+
+In particular, we appreciate support in the following areas:
+
+- Reporting issues.
+- Fixing and responding to [Sovryn Origins's GitHub issues](https://github.com/Sovryn-Origins/origins/issues)
+- Improving the documentation.
+- Translating the documentation into more languages.
+
+To get started, you can try to setup the repo locally. Run the tests. Check the scripts in `development` or other local blockchain, then even on testnets. Also, it may be useful to become well-versed at writing smart-contracts in Solidity.
+
+Please note that this project is released with a [Contributor Code of Conduct](https://raw.githubusercontent.com/Sovryn-Origins/origins/CODE_OF_CONDUCT.md). By participating in this project - in the issues, pull requests, or chat channels - you agree to abide by its terms.
+
+# How to Report Issues
+
+To report an issue, please use the [GitHub issues tracker](https://github.com/Sovryn-Origins/origins/issues). When reporting issues, please mention the following details:
+
+- Function Call.
+- Steps to reproduce the issue.
+- Actual vs. expected behaviour.
+
+Reducing the source code that caused the issue to a bare minimum is always very helpful and sometimes even clarifies a misunderstanding.
+
+# Workflow for Pull Requests
+
+In order to contribute, please fork off of the `development` branch and make your changes there. Your commit messages should detail _why_ you made your change in addition to _what_ you did (unless it is a tiny change).
+
+Additionally, if you are writing a new feature, please ensure you add appropriate test cases in [tests](tests) as mentioned below.
+
+However, if you are making a larger change, please consult with the [Contributors of Sovryn Origins](https://discord.gg/gjkPdRT9kA).
+
+Also, even though we do CI testing, please test your code and
+ensure that it builds locally before submitting a pull request.
+
+Thank you for your help!
+
+# Running the Tests
+
+## Prerequisites
+
+First install all the npm packages:
+
+```
+npm ci
+```
+
+## Running the Tests
+
+To run tests written in JS:
+
+```
+npm run test
+```
+
+## Writing Tests
+
+Tests are mainly written in JS and run using `hardhat`.
+
+Find the appropriate folder in test to write the tests for a particular test.
+
+For a new smart contract, tests should cover different personas, like creator, owner/admin, user, state changes, event emitted, etc.
+
+If there is a common custom function, write it in [utils.js](tests/utils.js), and import into the required tests.
+
+If there are constants or variables, declare them in [constants.js](tests/constants.js) & [variable.js](tests/variable.js) respectively.
+
+Code Coverage is good, complete functionality test (unit & integration) is better.
+
+## English Language
+
+Use English, with British English spelling preferred, unless using project or brand names. Try to reduce the usage of
+local slang and references, making your language as clear to all readers as possible. Below are some references to help:
+
+- [Simplified technical English](https://en.wikipedia.org/wiki/Simplified_Technical_English)
+- [International English](https://en.wikipedia.org/wiki/International_English)
+- [British English spelling](https://en.oxforddictionaries.com/spelling/british-and-spelling)