Add a CHANGE LOG tab alongside the README tab please #143176
Replies: 5 comments 1 reply
-
💬 Your Product Feedback Has Been Submitted 🎉 Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users. Here's what you can expect moving forward ⏩
Where to look to see what's shipping 👀
What you can do in the meantime 💻
As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities. Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐ |
Beta Was this translation helpful? Give feedback.
This comment was marked as off-topic.
This comment was marked as off-topic.
-
Hi @andreszs, I've added a Could you please help me figure out what I might be missing? |
Beta Was this translation helpful? Give feedback.
-
Hi sulaman0 There are some isuues for the result. File Name: Make sure the file is named exactly CHANGELOG.md (it’s case-sensitive). GitHub recognizes this specific name for changelogs. Location: The CHANGELOG.md file should be in the root directory of your repository for it to show up next to the README.md. Branch: Ensure you’re looking at the correct branch where the CHANGELOG.md file is located. If it’s on a different branch, it won’t appear in the one you’re currently viewing. Repository Settings: Check if there are any settings that might be hiding certain files. Refresh: Sometimes changes don’t show up right away due to caching. Try refreshing your browser or clearing your cache. GitHub Features: GitHub automatically recognizes some files (like README.md and LICENSE), but it doesn’t always create a separate tab for every file like CHANGELOG.md. It may just be listed among the other files. Thank you for your time |
Beta Was this translation helpful? Give feedback.
-
@skytech2510 I've been using GitHub for longer than I can remember, however, I've never seen a single repo with a CHANGELOG tab. Could you link me to a repo where such thing actually works? If someone reviews the source code of such feature, they'll surely notice it doesn't work as intended. PS. kindly do not provide an AI-generated answer, because yours looks exactly like something GPT would reply.... Refresh the browser? |
Beta Was this translation helpful? Give feedback.
-
Select Topic Area
Product Feedback
Body
GitHub repositories could improve the visibility and encourage the adoption of the CHANGELOG.md file by simply creating the missing CHANGE LOG tab for it, alongside the README and LICENSE tabs already present.
Currently, many developers (myself included) incorrectly use README.md to add a "Change Log" section, since it includes important information that otherwise could be easily overlooked by developers.
Adding this tab will greatly improve the adoption of the CHANGELOG.md file and make it clearly visible to all users.
Here is a sample preview of this feature:
PS. the tab should be called CHANGE LOG and point to CHANGELOG.md alone, and since it's far more relevant than the LICENSE tab it should be right after the README tab.
Beta Was this translation helpful? Give feedback.
All reactions