Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎨 Create CONTRIBUTING.md guide for open source contribution #799

Open
JFWooten4 opened this issue Jul 16, 2024 · 3 comments
Open

🎨 Create CONTRIBUTING.md guide for open source contribution #799

JFWooten4 opened this issue Jul 16, 2024 · 3 comments

Comments

@JFWooten4
Copy link
Contributor

What problem does your feature solve?

GitHub content, community interactions, and actual code all coalesce into our collective documentation.1

Accordingly, we can create stellar docs detailing our knowledge, collectively describing how the network functions. 👩‍💻

Today's nonexistent contribution style guide leaves one person voicing opinions with a centralized SDF reviewer.2 This isn't fair for the reviewer's time, the contributor's confusion, or the browser's sanity. Moreover, a clear style guide can help developers independently build in line with our shared vision. 🌄

What would you like to see? 📝

A style guide under the CONTRIBUTING.md page. A CONTRIBUTING.md file which explicitly details general collaboration styles.

We respectfully submit that an independent Contributing page outside of stellar-docs/README.md would significantly further community collaboration since:

  • The Contributing page could act as a single frame of reference for cooperative ecosystem developers, 🤝
  • The README page could be specialized to introduce visitors to the open-source network documentation, 👀 and
  • Nuanced author participation tips could be collected to support an inclusive submission opportunity. 🌐

Ultimately, might these guideposts steer us all towards a newfound documentation experience, without unnecessary missteps?3

What alternatives are there?

  1. We could leave the community reviewers up to their own devices when manually looking over pull requests. This is what happens now, and contributions often get merged despite conflicting syntax. 🤔 I'm not saying that you must follow the guidelines 100% or else get rejected; just proposing that they exist in the first place when someone does want to follow the standard practice or clean up existing work.

  2. We could use Stella, stricter prettier logic, or some other AI to automate the formatting amendments. 🤖

  3. Do nothing and leave my conscious unbearably restless, likely causing nightmares. 👻

Footnotes

  1. See, e.g., the discussion of maximum network throughput getting fragmented between Discord chats, SDF posts, and GitHub PRs rather than actual ecosystem proposals, dedicated GitHub discussions, or public developer meetings.

  2. See, e.g., isolated discussions on example orders, cross-referencing, code spacing.

  3. See, e.g., one page which starts off using two space indents (most common throughout docs) and then transitions to using tab indention. These conflicts should be fairly simple to rectify using existing tools. It would also be nice to document when, where, and how to insert README.mdx files, in an effort to create a readable repository.

@ElliotFriend
Copy link
Contributor

ElliotFriend commented Jul 19, 2024

This is a fantastic idea! I think I remember there being a similar issue (or maybe a few of them?) being created at some point, but they've (obviously) not been taken up yet. Really good ideas in here!

Edit: Here's the issue I was thinking of, although this one here is far more thorough and complete.

@janewang janewang changed the title 🎨 Create a style guide 🎨 Create CONTRIBUTING.md guide for open source contribution Jul 19, 2024
@janewang
Copy link
Contributor

@JFWooten4 Great idea, thanks for sharing

@NFTETGB
Copy link

NFTETGB commented Oct 1, 2024

🤣😂🙈 I'm glad everyone is impressed and likes my ideas. As you all can tell, a lot of work has been done, and as you can all tell, there is still Mork work ahead of me (US). 😇

On the serious side, I could use about 4 extra days in a week as unexpected ivence seems to be my better half, robbing me from all free time . Stretch to tin 🤴 I'm definition. Alt season just around the corner, and I'll have to prioritize that contributing to network well-being just in different way 😝 different approaches, better results, bringing capital and hunger for success investors to the Stellar ecosystem 😉 and giving you all time to proces fast pace of the amount of work is being done ☺️.

2 jobs 2 business in 2 different tome zones 6h difference leaves me with will to do but no way to accurately do. BEST REGARDS YOURS CAPITAN 🫡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

5 participants
@janewang @ElliotFriend @NFTETGB @JFWooten4 and others