-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Public repo preparation (#784)
* chore: Add CODE_OF_CONDUCT.md, CONTRIBUTING.md, and LICENSE * chore: Remove fastlane in preference to Apple automatic provisioning * chore: Remove certs in iOS directory * chore: Sanitize sentry.properties
- Loading branch information
1 parent
1358238
commit 1d100ff
Showing
65 changed files
with
333 additions
and
496 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# Hylo Code of Conduct | ||
Our mission is to amplify cooperation for people regenerating our communities and our planets. Our work is in service to this goal, and to the vision of a world where all beings can thrive. This translates directly to our culture of co-creation around Hylo, where we treat each other in ways that contribute to the thriving of each of us as individuals as well as the Hylo ecosystem as a whole. | ||
|
||
Please review our [Design Principles](CONTRIBUTING.md) to learn more about the principles underpinning how we build Hylo. | ||
|
||
## Our Pledge | ||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in Hylo 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 | ||
- Attempting collaboration before conflict | ||
- Focusing on what is best for the community | ||
- Showing empathy towards other community members | ||
- Paying attention to airtime, allowing space for others to speak, and not interrupting | ||
|
||
Examples of unacceptable behavior by participants include: | ||
- Violence, threats of violence, or inciting others to commit self-harm | ||
- The use of sexualized language or imagery and unwelcome sexual attention or advances | ||
- Trolling, intentionally spreading misinformation, 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 | ||
- Abuse of the reporting process to intentionally harass or exclude others | ||
- Advocating for, or encouraging, any of the above behavior | ||
- 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 us. 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. | ||
|
||
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. | ||
|
||
If you are unsure whether an incident is a violation, or whether the space where the incident took place is covered by our Code of Conduct, we encourage you to still report it. We would prefer to have a few extra reports where we decide to take no action, than to leave an incident go unnoticed and unresolved that may result in an individual or group to feel like they can no longer participate in the community. Reports deemed as not a violation will also allow us to improve our Code of Conduct and processes surrounding it. If you witness a dangerous situation or someone in distress, we encourage you to report even if you are only an observer. | ||
|
||
## Attribution | ||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Hylo Contribution Guide | ||
|
||
## Why contribute to Hylo? | ||
|
||
Hylo is a co-created and community-led platform. As an open-source project (as opposed to closed-source, proprietary technology), everyone is free to look at the codebase and add to it, and we don't charge people to use the platform. Hylo doesn't exist to maximize revenue for anyone. Instead, Hylo's purpose is to help groups organize impactful action. | ||
|
||
Hylo relies on donations - of money, and of time and energy from people who share a vision for a world where our collective resources are shared as a commons. Our water, our land, and even our technology tools can be cooperatively stewarded by the community, for the benefit of all. | ||
|
||
Do you dream of a world that works for all? If so, Hylo could benefit from your care. Here’s how to get involved. | ||
|
||
## Our Culture & Design Principles | ||
As the builders of a collaboration platform, we strive for helpful and respectful interactions. Our culture is kind and encouraging, and it’s important to us that the community creating Hylo is a safe and welcoming space for all. | ||
|
||
These are the values we embed at every level of our stack. Please read our [Code of Conduct](CODE_OF_CONDUCT.md) to learn more about how to move in this space. | ||
|
||
### Seven-generation thinking | ||
We are building tools for long-term planetary thriving; so that our children have clean air to breath and healthy food to eat. | ||
|
||
### Relationship-centered design | ||
We work in deep partnership with all stakeholders, optimizing for trust and relationship-building with every other community this work touches. We do this by prioritizing co-creative product and design sessions, sharing a transparent product journey, and inviting suggestions and engagement from all Hylo stakeholders to ensure we are building for real needs of real communities. | ||
|
||
### Transparency | ||
Hylo is open source and our operations, finances, and governance are open to all. | ||
|
||
### Interoperability | ||
We contribute to and create open standards and protocols wherever possible, and work to integrate with as many existing platforms as we can, especially those which are open source and values aligned. | ||
|
||
### Privacy and User Sovereignty | ||
Your data belongs to you, not us. We will never sell your data or share it without your explicit request. You can export and delete your data as you wish. | ||
|
||
### Inclusivity | ||
We are committed to ensuring these tools are shaped by and effectively serve diverse communities. Hylo will be accessible to all by remaining free to use in perpetuity. To support the development, we lean into the Gift and ask every stakeholder to contribute what they can. | ||
|
||
### Collective Stewardship | ||
Hylo is already developed by consensus among the Terran Collective stewards, and in deep partnership with our users. Eventually, Hylo will be stewarded by the community as a platform cooperative, where all users are stakeholders who may participate in the collective governance of the platform and receive abundance from its success. | ||
|
||
If these resonate with you, we’d love for you to join the community of Hylo contributors. | ||
|
||
## How to help | ||
There are so many ways to contribute to Hylo, and we’d be delighted for you to participate in whatever way is most exciting to you! Of course, as a software project, we are always welcoming volunteer coders. But you don’t have to contribute code to be helpful! Regardless of your technical chops, there’s plenty to do. | ||
|
||
### Here are some important ways to help out: | ||
- Beta test new releases to ensure high quality functionality | ||
- Create documentation, such as onboarding materials to help communities thrive on Hylo | ||
- Submit feedback, bug reports, and feature requests | ||
- Contribute code! | ||
|
||
To get involved in beta testing, creating onboarding materials, or offering feedback on product ideas or designs, join [Building Hylo](https://www.hylo.com/groups/building-hylo/join/RcDe6vcG7u). | ||
|
||
We accept bug reports through Intercom within the Hylo web application, or by creating a ticket on our [GitHub repo](https://github.com/Hylozoic/hylo-evo). | ||
|
||
We accept [feature requests here](https://airtable.com/shrSt2NpmQbHhQxoO). | ||
|
||
Have more ideas about how you’d like to contribute to Hylo? Please get in touch at hello@hylo.com and let us know how you’d like to help. | ||
|
||
## Developers | ||
We are actively seeking developers to join our mission to amplify cooperation among people regenerating our communities and our planet. Our codebase is written in JavaScript and we use React/Redux/GraphQL on the front-end and Node + Postgres on the backend. To check out what we’re working on right now, head over to our [project board](https://github.com/orgs/Hylozoic/projects/1) on Github. | ||
|
||
### Our dev process | ||
Hylo is stewarded by a team of engineers, designers, artists, and product managers from [Terran Collective](https://www.terran.io/). We create project scopes in partnership with organizations who use Hylo and have resources to share to help improve the platform for everyone. These project scopes guide us to set a timeline and assemble a team to carry out the development in co-creation with our partners. Right now, we meet weekly for collaborative sprint planning and backlog generation. We also like to pair program, and have deep dive product conversations. If you’d like to be a part of it, here’s what to do: | ||
|
||
### Platform setup | ||
The platform is currently sustained by several repos; hylo-evo, hylo-node, hylo-shared and HyloReactNative. Evo covers the React-based web-app. Node is the node.js backend, relying on a redis cache and a postgres db. HyloReactNative is the mobile app (the repo is private right now, we just haven't had priority to open source it yet). Hylo-shared has a bunch of helper functions and other code shared between all the other repos. We are considering making the jump to a mono-repo, and would love help from those experienced with such a transition. | ||
|
||
You will need to get at least EVO and NODE up and running in your local setup to contribute code. There are docker images several parts of the back-end as well, documented in the NODE repo. [The .devcontainer README](https://github.com/Hylozoic/hylo-node/blob/dev/.devcontainer/README.md) details some setup aspects, although its been some time since any of us have tried the direct vs code integration. Docker desktop now automatically runs images that were running on shutdown, so that has streamlined the process of using the docker images. | ||
|
||
### Steps to get involved: | ||
- Join the [Building Hylo](https://www.hylo.com/groups/building-hylo/join/RcDe6vcG7u) group, our open source community for people co-creating Hylo! | ||
- Reach out to Hylo's tech lead Tibet Sprague to say hi: tibet [at] hylo [dot] com | ||
- Set up your development environment: Follow the READMEs in [hylo-evo](https://github.com/Hylozoic/hylo-evo) and [hylo-node](https://github.com/Hylozoic/hylo-node) | ||
- Watch the developer onboarding recording (link coming soon!) | ||
- Check out the [Project board](https://github.com/orgs/Hylozoic/projects/1) and look for tickets with [Good First Ticket](https://github.com/Hylozoic/hylo-evo/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+first+ticket%22) label | ||
- If you get stuck, please reach out for support by sending Tibet a DM on Hylo | ||
|
||
### How to make a pull request | ||
- If it's your first time contributing to Hylo, please make a fork and PR from that fork. | ||
- For more contributions, let’s have a conversation and get to know each other if we haven’t already, and we can explore involving you more deeply in our team flow including inviting you to our organization on Github. | ||
|
||
## Thank you so much for co-creating Hylo! |
Oops, something went wrong.