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

Update classifying-your-repository-with-topics.md #31443

Closed
wants to merge 3 commits into from

Conversation

Julian-Dumitrascu
Copy link

@Julian-Dumitrascu Julian-Dumitrascu commented Feb 5, 2024

I've updated the section "Adding topics to your repository".

  1. It did not include the first step.
    Sol Content follows e.g. this principle: Try to provide complete instructions!
  2. The word "click" is outdated; people can give such commands without making any noise.
    We can agree on a verb that describes satisfactorily how we use controllers.
  3. It is useful to describe controllers.
  4. We can discuss the extent to which users want a program to display e.g. a word or an image on a button.
    We can schedule talks (How are we going to schedule activities? Sol-Global-Management/data-management#10) about writing user guides.

Why:

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

I've updated the section "Adding topics to your repository".
1. It did not include the first step.
Sol Content follows e.g. this principle: Try to provide complete instructions!
2. The word "click" is outdated; people can give such commands without making any noise.
We can agree on a verb that describes satisfactorily how we use controllers.
3. It is useful to describe controllers.
4. We can discuss the extent to which users want a program to display e.g. a word or an image on a button.
We can schedule talks (Sol-Global-Management/data-management#10) about writing user guides.
Copy link

welcome bot commented Feb 5, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 5, 2024
Copy link
Contributor

github-actions bot commented Feb 5, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md fpt
ghec
ghes@ 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Feb 5, 2024
@nguyenalex836
Copy link
Contributor

@Julian-Dumitrascu Thanks so much for opening a PR! I'll get this triaged for review ✨

@Julian-Dumitrascu
Copy link
Author

I'm new to your procedure. I can use GitHub more and more usefully.

@sophietheking sophietheking self-requested a review February 26, 2024 16:31
@sophietheking
Copy link
Contributor

@Julian-Dumitrascu 👋

Thanks so much for this submission, and for taking the time to write this up in detail. ✨ The team decided we're not going to making this change and I'm going to close this PR.

The use of the word "click" aligns with our Style Guide.

If the repository is empty, the "About" sidebar (and the gear icon) are not shown. Instead of adding the extra step, I would suggest adding a note to step 2, something about the "About" sidebar not being shown for empty repositories. Feel free to open a new PR to add this! 🔨 For more information about notes, see "Callouts" in our Style Guide.

Thank you again for contributing to our docs. 💛 It may help in future to first open an issue for this kind of proposed change, so that we can provide any feedback in advance, but in any case thank you again for your submission and do please also feel free to take a look at our "Help wanted" board! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team repositories Content related to repositories waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants