docs: add standard public repository info (#47)

* docs: add standard public repository info

* chore: point workflow to main branch

Author: jrriehl

.github/workflows/ci.yml

@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   build:

CODE_OF_CONDUCT.md

@@ -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 [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 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>

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions to this library are welcome.
+
+- If you want to report a bug or ask for features, you can check the [Issues page](https://github.com/fetchai/jenesis/issues) and raise an issue.
+
+- If you would like to contribute a bug fix or feature then [submit a Pull request](https://github.com/fetchai/jenesis/pulls).
+
+Before reading on, please have a look at the [code of conduct](CODE_OF_CONDUCT.md).
+
+## A few simple rules
+
+- Before working on a feature, reach out to one of the core developers or discuss the feature in an issue. The framework caters a diverse audience and new features require upfront coordination.
+
+- Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
+
+- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
+
+- Keep API compatibility in mind when you change code in `jenesis`. Above version `1.0.0`, breaking changes can happen across versions with different left digit. Below version `1.0.0`, they can happen across versions with different middle digit. Reviewers of your pull request will comment on any API compatibility issues.
+  
+- When you contribute a new feature to `jenesis`, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.
+
+- Where possible, extend existing features instead of replacing one.
+
+- Before committing and opening a PR, run all tests locally. This saves CI hours and ensures you only commit clean code.
+
+## Contributing code
+
+If you have improvements, send us your pull requests!
+
+A team member will be assigned to review your pull requests. All tests are run as part of CI as well as various other checks (linters, static type checkers, security checkers, etc). If there are any problems, feedback is provided via GitHub. Once the pull requests is approved and passes continuous integration checks, you or a team member can merge it.
+
+If you want to contribute, start working through the codebase, navigate to the Github [Issues page](https://github.com/fetchai/jenesis/issues) tab and start looking through interesting issues. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
+
+## Commits and PRs
+
+This project uses Conventional Commits to generate release notes and to determine versioning. Commit messages should adhere to this standard and be of the form:
+
+```bash
+git commit -m "feat: add new feature x"
+git commit -m "fix: fix bug in feature x"
+git commit -m "docs: add documentation for feature x"
+git commit -m "test: add test suite for feature x"
+```
+
+Further details on `conventional commits` can be found here: <https://www.conventionalcommits.org/en/v1.0.0/>
+
+When merging a branch, PRs should be squashed into one conventional commit by selecting the `Squash and merge` option. This ensures Release notes are useful and readable when releases are created.
+
+<!-- ![alt text](https://docs.github.com/assets/images/help/pull_requests/select-squash-and-merge-from-drop-down-menu.png) -->
+<img src="https://docs.github.com/assets/images/help/pull_requests/select-squash-and-merge-from-drop-down-menu.png" alt="drawing" style="width:600px;"/>

DEVELOPING.md

@@ -0,0 +1,26 @@
+## Development setup
+
+The easiest way to get set up for development is to install Python `>=3.7` and [poetry](https://pypi.org/project/poetry/), and then run the following from the top-level project directory:
+
+```bash
+  poetry install
+  poetry shell
+```
+
+## Development commands
+
+There are various makefile commands that help the development. Some of them are:
+
+- To run lint checks:
+
+  ```bash
+    pylint
+  ```
+
+- To run tests:
+
+  ```bash
+    pytest
+  ```
+
+Before committing and opening a PR, use the above commands to run the checks locally. This saves CI hours and ensures you only commit clean code.

README.md

@@ -1,3 +1,30 @@
-# Fetch.ai CLI
+Jenesis is a command line tool for rapid contract and service development for CosmWasm-enabled blockchains.
 
-An initial prototype for a command line tool for rapid contract and service development
+# Installation
+
+Install jenesis for Python 3.7 or newer via PyPI:
+
+```
+pip install jenesis
+```
+
+# Getting started
+
+## Create a new project
+
+```
+jenesis new my_project
+```
+
+## Initialize jenesis in an existing project directory
+
+```
+jenesis init
+```
+
+## Compile contracts
+
+
+```
+jenesis compile
+```