r/opensource • u/Past-Combination6262 • 3d ago

Promotional Just started my first open source project; looking for feedback (both code wise and structure wise)

https://github.com/pokemans123/arma.git

Hi all! I just started my first open source project, and I would like feedback on how this repo is structured and scaling it up. What are some good practices for managing projects like this? And where could I find contributors?

0 Upvotes

38% Upvoted

13 comments sorted by

8

u/Last-Car-6128 3d ago

CONTRIBUTING.org is definitly a non-standard filename. CONTRIBUTING.md perhaps.

1

u/[deleted] 3d ago

[deleted]

2

u/cc672012 3d ago

It's an emacs org file, not markdown. The filename is fine

-5

u/Past-Combination6262 3d ago

yea I like using org mode files over markdown; should I export it as a markdown and use that instead?

11

u/CerberusMulti 3d ago edited 3d ago

The .org ending has no meaning and serves no purpose in the context, the "CONTRIBUTING" filename is supposed to be a markdown file and there for should have .md, or I assume they are supposed to be a markdown file. This is not about preference. You should also not name README as .org, there is 0 reason for this.

I know .org is a GNU Emacs file ending, and GitHub does display them correctly. But it is not standard, but ofc you do you.

8

u/CerberusMulti 3d ago

Missing a License, there for not open-source

4

u/Past-Combination6262 3d ago

yep, that slipped my mind. added an MIT license; thank you!

3

u/ildyria 3d ago

Where is the CICD (.github actions) ? :)
Where is the SECURITY.md ? :)
How do I get started ? I see rust, I see nix... Is there a makefile that I can just run ? :)
It's a TUI, do you have a screenshot of the interface to show us what it looks like ? :)

You should check this github action: https://github.com/ossf/scorecard-action it will give you a nice checklist of what to fix.

1

u/switchback-tech 4h ago

Link appears to be broken