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

Add contributing guidelines and organize developer documentation #4345

Merged
merged 5 commits into from
Nov 28, 2023

Conversation

MisRob
Copy link
Member

@MisRob MisRob commented Nov 27, 2023

Summary

  • Adds CONTRIBUTING.md (including its copy in README.md)
  • Removes development related information from README.md in favor of adding index file and organizing all content into chapters of the development documentation directory
    • To make contributing guidelines visible
    • To make locating information easier
    • To align documentation structure with Kolibri and KDS
  • Also updates config.yml so that redirects to Discussions and LE forum are available when opening a new issue
    Screenshot from 2023-11-27 12-31-01 (screenshot from Kolibri)

Reviewer guidance

to make orientation easier and free up
a visible spot in the readme for the
contributing guidelines copy.

- Organizes content into chapters
- Adds index file
- Slightly tweaks some of the chapters titles
  and sections heading levels

Doesn't remove nor rewrites content.
Copy link
Member

@bjester bjester left a comment

Choose a reason for hiding this comment

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

LGTM

@vkWeb
Copy link
Member

vkWeb commented Nov 27, 2023

I think we should annotate that the "With docker" setup is recommended from our side. From what I have observed, open source developers tend to use recommended methods, so that less issues pop up later down the road. Thoughts @bjester @MisRob ?

@bjester
Copy link
Member

bjester commented Nov 27, 2023

@vkWeb Yeah that is the recommended setup, so it's worthwhile to mention that

@MisRob
Copy link
Member Author

MisRob commented Nov 28, 2023

Thanks both, I mentioned that Docker setup is recommended in a few places. It's also the page where you will be taken from the contributing guidelines.

@MisRob MisRob merged commit 1974bfb into learningequality:unstable Nov 28, 2023
9 checks passed
@MisRob MisRob deleted the contributing-docs branch November 28, 2023 16:17
@akolson akolson mentioned this pull request Aug 13, 2024
@akolson akolson mentioned this pull request Oct 1, 2024
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.

3 participants