Skip to content

Welcome to satiscode #19

Description

@gtref

🧭 Welcome to satiscode — Start Here (Onboarding Hub)

👋 Welcome!

Thanks for checking out satiscode — this issue is your starting point for contributing.
Whether you're fixing bugs, adding features, or improving docs, this page will guide you through everything you need.

Note

Please note the changes in issue #32

All ideas of features are welcome here


📘 What is satiscode?

A lightweight, minimal code editor focused on:

  • Speed
  • Simplicity
  • Clean UI
  • Useful features (search, tabs, themes, settings, etc.)
  • Easy contribution workflow

The goal is to keep satiscode small, readable, and friendly for new contributors.


🛠 How to Build & Run

See CONTRIBUTING.md for:

  • Build steps
  • Development workflow
  • How to run satiscode locally
  • How to submit PRs

Everything you need is already documented.


📚 Important Links

  • README.md — project overview
  • CONTRIBUTING.md — build instructions
  • CONTRIBUTERS.md ___ List of all those who have helped out
  • CODE_OF_CONDUCT.md — community rules
  • SECURITY.md — security policy
  • Issue Templates — bug reports & feature requests
  • Discussions — ask questions, share ideas

🎯 Pick Your First Task

🟦 Beginner‑Friendly

  • Improve documentation (README, docs folder)
  • Add comments to existing code
  • Fix small UI inconsistencies
  • Add missing keyboard shortcuts

🟩 Intermediate

  • Add new editor features
  • Improve search (Ctrl+F)
  • Add new settings options
  • Improve file tree navigation

🟧 Advanced

  • Refactor core editor logic
  • Implement multi‑tab editing
  • Add theme customization system
  • Add plugin support

🧩 Permanent Roles (Optional)

If you want to help long‑term, here are ongoing roles:

📘 Documentation Maintainer

  • Keep README updated
  • Update docs when new features land
  • Improve clarity and examples

🧪 Testing & QA

  • Test new features
  • Report bugs
  • Suggest improvements

🎨 UI/UX Contributor

  • Improve layout
  • Suggest design changes
  • Add accessibility improvements

📨 How to Join

Comment below:

“I’d like to help — please assign me a task.”

Or pick any issue and ask to be assigned.


⭐ After Your First PR

Once your PR is merged:

  • You’ll be added to CONTRIBUTORS.md
  • You can take another issue
  • You can join discussions
  • You can help shape the roadmap

🎉 Welcome aboard!

Thanks for helping build satiscode — every contribution matters.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions