Welcome to satiscode

Open
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Active

Research direction

Start by reading CONTRIBUTING.md and README.md, then check issue #32 for the referenced changes. This issue is an onboarding hub rather than a scoped documentation task, so it has no specific file to edit or completion condition; a contributor would need a defined target before starting.

Written by the indexing model from the issue text.

Description

good first issue onboarding start here

🧭 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.

Dominant language
HTML
Stars
1
Forks
1
Avg merge
1h 53m
Merged PRs (30d)
27

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from gtref/satiscode

All issues in gtref/satiscode

Similar issues

More DevTools issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.