Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 3.45 KB
Raw

Contributing to the 01 App ●

Thank you for your interest in contributing to the 01 App.

This is an early stage, ambitious project aiming to improve how we interact with technology. We're just getting started, which means there's plenty of open space for collaboration and innovation.

Whether you're interested in developing new features, improving existing ones, or enhancing our documentation, your contributions are incredibly valued. We're still figuring things out as we go, and your input can help shape the future of this project.

The following guidelines will help you get started with contributing to 01 App. While these aren't strict rules, we encourage you to use your best judgment. If you have ideas for improving this document or any questions about contributing, don't hesitate to reach out. You can propose changes through a pull request or join our Discord community for more discussion and support.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Contribution Guidelines

  1. Before taking on significant code changes, please discuss your ideas on Discord to ensure they align with our vision. We want to keep the codebase simple and unintimidating for new users.
  2. Fork the repository and create a new branch for your work.
  3. Follow the Running Your Local Fork guide below.
  4. Make changes with clear code comments explaining your approach. Try to follow existing conventions in the code.
  5. Follow the Code Formatting and Linting guide below.
  6. Open a PR into main linking any related issues. Provide detailed context on your changes.

We will review PRs when possible and work with you to integrate your contribution. Please be patient as reviews take time. Once approved, your code will be merged.

What should I work on?

Please pick up a task from issues.

If you encounter a bug or have a feature in mind, search if an issue already exists. If a related issue doesn't exist, please open a new issue.

Running Your Local Fork

Once you've forked the code and created a new branch for your work, you can run the fork by following these steps:

  1. CD into the /app directory
  2. Install dependencies bun install
  3. Install and run the app on your simulator bun ios or bun android

Code Formatting and Linting

Check back later, we will populate this soon!

Licensing

Contributions to 01 are under AGPL-3.0

Questions?

Join our Discord community and post in the #general channel to connect with contributors. We're happy to guide you through your first open source contribution to this project!

Thank you for your dedication and understanding as we continue refining our processes. We sincerely appreciate your interest and involvement as we explore this extraordinary new technology.