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

docs(README): Expand details for devs/contributors + misc tweaks #541

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Mar 19, 2024

Closes #503

Builds on latest README changes from #539. Attempts to add notes useful to those looking to make changes to the Updater or understand its internals and how it fits in with the other pieces.

Also:

  • Corrects a couple typos
  • Adds some additional relevant config parameters
  • Some minor structural tweaks

Lastly:

  • Further refinements can be built on this foundation as needed.
  • Appropriate bits will eventually make there way into the Nextcloud Admin Manual

README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@come-nc come-nc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m not a fan of the "Possible future work" section, feature requests should go in issues, not in the README.
Also, things as vague as "Improve documentation" or "Performance optimizations" are useless, they are possible future work of any project out there.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@joshtrichards joshtrichards force-pushed the enh/readme/dev-notes-plus-misc-tweaks branch from e6e5b15 to 24c71ff Compare April 1, 2024 13:29
@joshtrichards joshtrichards changed the title enh(README): Expand details for devs/contributors + misc tweaks docs(README): Expand details for devs/contributors + misc tweaks Apr 1, 2024
@joshtrichards
Copy link
Member Author

Though just the README, test-master will fail until #543 + nextcloud/password_policy#566 are merged.

Signed-off-by: Josh <josh.t.richards@gmail.com>
@come-nc come-nc force-pushed the enh/readme/dev-notes-plus-misc-tweaks branch from 24c71ff to bab0afc Compare April 2, 2024 09:08
@come-nc come-nc merged commit 4af30bd into master Apr 2, 2024
23 checks passed
@come-nc come-nc deleted the enh/readme/dev-notes-plus-misc-tweaks branch April 2, 2024 12:17
Copy link

github-actions bot commented Apr 3, 2024

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

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

Successfully merging this pull request may close these issues.

README
4 participants