Giter VIP home page Giter VIP logo

pangea-docs's Introduction

BITNATION and Pangea Documents, Resources and Contributor Guidelines

✌️ The community is one of the driving forces of BITNATION. To be resilient, we need a decentralised community of contributors, as much as a decentralised technology. It doesn’t matter what your profession is, your skill level, your nationality, age, education or gender. Everyone is welcome to join in to help make BITNATION and our Pangea software a success that changes the status quo of governance. 🌎🌏🌍

To get to know us, the best place to start is through:

Visit the Bitnation website, and the Pangea website.

If you want to familiarise yourself with Bitnation, here are some key documents to read:


BITNATION Overview and Philosophy:

BITNATION and Pangea History:

Media Channels:

MISC:

Translations:

Key documents like the Pangea Whitepaper are in separate folders in this repository. Current translations include:

If you want to contribute with additional translations, please contract @erik93 on the Slack channel.


Community Resources

If you want to contribute to the growth of the Bitnation community and our mission - this is the place for you.

The best place to get to know the community is to join our Slack channel and start contributing. It's helpful to write a short introduction about yourself and what you're interested in doing. Keep in mind that the Slack chat is not encrypted, and it's open for anyone to join, hence don't share anything you think could compromise your security, and use a pseudonym if you want to remain anoymous.

Popular channels you can join includes #_dev, #_marketing, #townhall, #intros, and #watercooler`.

The Slack community will be moved to Pangea after the Beta release.

Join the Ambassador and Embassy Networks

The Ambassador and Embassy networks were conceived as analogue versions of Pangea. A real world network of people and places where digital nomads can get advice, peer-to-peer assistance, meet-up and hang out. There are three types of Bitnation representatives:

  • Diplomatic Ambassadors: Official Bitnation positions to perform duties as Officers working as our interface with existing Nations, as well as new virtual Nations.
  • Diplomatic Consuls: Also an Official position. A support to both our Ambassadors and to Nation State embassies and consulates engaging with our Citizens in the location of our Embassies and Consulates.
  • Goodwill Ambassadors: Informal but officially recognised representative of Bitnation during events (such as DEVCONs). Promotes and supports Bitnation and our services and provides a point of contact for our Citizens.

Embassies and Consulates are where share their space, whether it’s an office, coffee shop or your home, and open it up for fellow citizens, hackers and crypto aficionados around the world! There are two types of places, Embassies and Consulates.

  • Embassy A place where you can both live, and work (and naturally, meet).
  • Consulate A place where you can work – like a shared office space or cafe, for instance – or maybe organise a meetup or a hangout.

Bitnation has over 100 embassies, consulates worldwide. You can find out more about the Ambassador Network or Register as an Embassy on our website. All these functions will soon be moved from the website to the Pangea software.

Start Your Own Nation

The Pangea software is setup for you to create your own Decentralized Borderless Voluntary Nation (DBVN). However, until Pangea v.03 is out you can do it yourself through using our DBVN code. Here are a few resources to help you setup your own Nation:

Submit a Local or Global Governance Project Idea

You can submit an idea for a local or global governance project on our website, and vote and discuss pros and cons of others people's proposal. Keep in mind that you're likely to get more feedback if your proposal have clear and specific goals, timelines, expected outcomes and measurable deliverables.

For now the Project page is mostly for discussing ideas, but after the ICO we'll be able to fund some of them through Smart Contracts.

Help with Documentation, Translation and Educational Resources

Good documentation is key for an Open Source Software movement.

  • Help documenting best practices, key events, processes etc.
  • Translate materials like Whitepapers, community updates, articles, videos. We're setting up this resource to help collaborate on translations.
  • Create manuals, videos and blog posts to help explain how to be part of the community and how to use the software.

Help Grow our Community through Outreach and Engagement

There are many ways to help grow the movement through outreach and communication. Here's a list of a few activites that are really impactful.

  • Organize Online Google Hangouts and Local Meetups.
  • Produce content, like YouTube videos, software demo videos, graphic materials, blog post etc.
  • Help new commers on Slack to understand BITNATION and find their way around Slack channels and other resources (like this one here).
  • Help people outside of our community to understand more about BITNATION, the Pangea software, cryptocurrencies, decentralized technologies, the importance of privacy and security and everything else beautiful in the world 😄.

Community Code of Conduct

The generic Citizen Code of Conduct is applied to most repositories and channels within BITNATION. However, here are some values we would like to highlight more specifically.

  • Clarity above all Understanding the challenges of communicating across different timezones, culture and personalities both during written and verbal communications. It’s advisable to avoid sweeping statements in favor of clearly articulated sentences with well defined purposes.
  • Refrain from jumping to conclusions A fundamental problem in many conversations is that we overestimate others capacity to understand our written and verbal communications, and we overestimate our own capacity to understand what they’re trying to communicate. When analyzing what the other person is trying to communicate, take their context into account, including things like timezone, native language, and personal circumstances.
  • Respectfulness We have come together to change the status quo through creating kickass software, to that end being disrespectful can divert the conversation from our set purpose into irrelevant areas. Personal slights and attacks does not foster a good collaborative space, it's wise to avoid them. When we are emotionally affected by communications, attempt to take a step backwards and swallow the chill pill.

Development Resources

Getting Started

The best way to get involved in the development process is through joining our slack after reading the following documentation. Relevant Slack channels are #dev for general dev discussions, and #dev-bots for realtime dev push notifications from GitHub, Trello and TravisCI.

Languages and Frameworks

  • Panthalassa, our mesh network backend was initially built in Golang, but is currently being refactored into JavaScript + Flow, follow the development here.
  • Pangea is our frontend under heavy redevelopment, this new version is made with React Native.
  • Our token Pangea Arbitration Token (PAT) is an ERC20 Solidity token.
  • Our AI Lucy who governs the reputation system is in Solidity, you can follow the progress here
  • The entity framework is made in Solidity.
  • The registry will be merged in the framework, it is in solidity too.

Whitepaper, Roadmap and Development Updates

Key-Repositories

We are pinning relevant repositories on our profile.

API and Documentation

UI/UX Resources

  • UI/UX matters are discussed on Slack and uploaded to Trello.
  • Please have a look at our branding guidelines repo where you will find resources like branding and UI source files.
  • Our Logo source files
  • Our Font Guidelines

Solidity Contracts

Release Model

  • Following the Scrum methodology we will be using sprint releases whenever possible.
  • Before releasing we are making sure all unit tests are passing.

Software Testing, Bug Bounties, and Bug Reports

We are trying to maximize our code testing coverage, thus all the different repositories are shipping with unit tests compliant to the language or framework standard.

  • The current version of the Pangea React frontend is being built here, please review and contribute.
  • You can test the Pangea application on your mobile phone using expo.io, simply install expo.io and scan the QR code with your phone.
  • The previous version of Pangea can be tested via npm thanks to npm run test (please install the dependencies with npm install first).
  • Travis CI is used per default in key-repositories
  • Panthalassa support the golang testing framework, use go test -v ./... in the cloned project (after downloading dependencies).
  • The entity framework uses truffle, everything is bundled via npm after installing dependencies via npm install just do npm run test.
  • The informations concerning the registry are detailed in its readme.
  • Key Solidity contracts are audited by external auditors, primarily ABDK Consultants.

Code Commit Guidelines and Code of Conduct

  • Some repositories includes issue or pull request templates, use them whenever possible.
  • Make your commit messages clear, and try to follow the same pattern than the one used in the target repo.
  • Please avoid duplicating any issue or pull request, any duplicate will be closed.
  • Split your different changes in a clear way via commits, it will make the reviewer's task easier.
  • Only one major change should be submitted per pull requests, help us review your code faster!
  • Last but not least: be respectfull, no abuses will be ever tolerated and could result to the close of your issue/pull request without further notice.

Additional Learning Resources:

Made with ❤️ at BITNATION.

pangea-docs's People

Contributors

xsttx avatar camilolunacom avatar ccmawo avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.