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

Improve README #2428

Open
jermanuts opened this issue Nov 23, 2024 · 3 comments
Open

Improve README #2428

jermanuts opened this issue Nov 23, 2024 · 3 comments

Comments

@jermanuts
Copy link
Contributor

The current README is confusing, long and contains a lot of grammar issues. I found myself opening PRs which is not up to the standard/structure of this repository as @plowsof kept noting, but it is because none of that is mentioned in the README.

Here are the few things that I found to be missing in the README (list is not exhaustive), please comment with other improvements you want to see:

  • For each PR have a separate branch with a decent short description

  • The commit message should have page name before it, for example: downloads: improve wallets description, User Guides: write a new guide about X...

Mention that Github generated table of contents, so readers can navigate easily (I myself didn't know GitHub had this feature 🤣 and found about it from selsta's comment)

This website is completely open-source however and anything and everything is available for changing should the community deem it necessary.

change it to: This site is completely open source, and everything is open to change if the community deems it necessary.

Add hyperlinks to file paths in README like _includes/onion.html and /onion.txt, also why is the onion subdomain not in _includes/onion.html?

I think we stopped using GitHub Project board? should we not mention it in PR workflow?

Translation (rip) while we wait for someone to take for it, Localization Workgroup should be removed as Erc stopped maintaining it.

@HardenedSteel
Copy link
Contributor

relevant to CONTRIBUTING.md

@plowsof
Copy link
Collaborator

plowsof commented Nov 25, 2024

HardenedSteel is correct, this is for contributing.md. there is a pull request (or something merged) regarding adding the filename being edited in the commit to monero-core repo somewhere. we can add it to contributing.md , but its not a priority. Alot of the times this is subjective for the maintainer. they may just be asking for a helping hand to help organise the merge list and anticipate merge conflicts.

The first half of this issue is just an update on your journey of earning your "contributor" flair. and part of being a good git-izen. no more making pull requests using master... if a maintainer asks you to rename a commit or reviewers ask for changes you don't spend weeks avoiding it... or creating a new branch to make the PR with changes instead of learning... you can rebase... amend... we're all proud of your journey and looking on with pride.

There are actionable tasks mentioned in this issue.

@plowsof
Copy link
Collaborator

plowsof commented Nov 25, 2024

monero-project/monero#9451 for commit title best practices.

This issue does not mention the pitfalls of updating wallets on the downloads page + mobile view (which can and should be generated progrsmatically anyway) but we're getting a new site soon(tm)

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

No branches or pull requests

3 participants