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

Clean up contributing documentation #245243

Merged
merged 42 commits into from
Aug 14, 2023
Merged

Commits on Aug 13, 2023

  1. doc/contributing: Remove unreferenced legacy diagram

    Not used anymore after b3fa79b
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    be26d79 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    d70091c View commit details
    Browse the repository at this point in the history
  3. README.md: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    b98abe5 View commit details
    Browse the repository at this point in the history
  4. CONTRIBUTING.md: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    b7c5258 View commit details
    Browse the repository at this point in the history
  5. doc/coding-conventions: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    
    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    1e1cd39 View commit details
    Browse the repository at this point in the history
  6. doc/contributing-to-documentation: Rough move to new contribution doc…

    … files
    
    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    74b17a5 View commit details
    Browse the repository at this point in the history
  7. doc/quick-start: Rough move to new contribution doc files

    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    90bf25d View commit details
    Browse the repository at this point in the history
  8. doc/reviewing-contributions: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    
    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    f3a050a View commit details
    Browse the repository at this point in the history
  9. doc/submitting-changes: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    
    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    86f14e4 View commit details
    Browse the repository at this point in the history
  10. doc/vulnerability-roundup: Rough move to new contribution doc files

    No content was changed, new titles are wrapped with () to signal that
    they will need to be decided on in a future commit.
    
    Section in the manual have been preserved with a simple redirect to
    GitHub, the proper anchors should be filled out in a future commit once
    the new section names are decided.
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    129da60 View commit details
    Browse the repository at this point in the history
  11. Configuration menu
    Copy the full SHA
    549ecbc View commit details
    Browse the repository at this point in the history
  12. CONTRIBUTING.md: Move opening issues section to Nixpkgs manual

    This isn't relevant to contributors specifically, it applies to all
    users
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    3796808 View commit details
    Browse the repository at this point in the history
  13. CONTRIBUTING.md: Remove temporarily

    So that the CONTRIBUTING-new.md can take its place and Git detect the
    rename
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    1a29060 View commit details
    Browse the repository at this point in the history
  14. Move CONTRIBUTING-new.md to CONTRIBUTING.md

    The -new version was assembled in the previous commits
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    350eb69 View commit details
    Browse the repository at this point in the history
  15. CONTRIBUTING.md: Add intro

    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    3d5fc07 View commit details
    Browse the repository at this point in the history
  16. Configuration menu
    Copy the full SHA
    ecee8c3 View commit details
    Browse the repository at this point in the history
  17. Configuration menu
    Copy the full SHA
    44293fb View commit details
    Browse the repository at this point in the history
  18. Configuration menu
    Copy the full SHA
    9489e19 View commit details
    Browse the repository at this point in the history
  19. Configuration menu
    Copy the full SHA
    dfe311b View commit details
    Browse the repository at this point in the history
  20. CONTRIBUTING.md: Coding conventions -> code conventions

    It's not conventions about how to do coding, it's about what the code
    should look like
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    99c6942 View commit details
    Browse the repository at this point in the history
  21. CONTRIBUTING.md: Write a new section on how to propose a change

    Removing paragraphs from the other sections that aren't necessary anymore
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    67ae88c View commit details
    Browse the repository at this point in the history
  22. CONTRIBUTING.md: Clean up "Making patches" section

    Moving and collecting bits into the appropriate places, also writing
    some new sentences
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    5789cc3 View commit details
    Browse the repository at this point in the history
  23. Configuration menu
    Copy the full SHA
    aace54f View commit details
    Browse the repository at this point in the history
  24. CONTRIBUTING.md: Replace staging workflow diagram

    Can't be rendered in GitHub markdown, replacing it with a Git branch diagram using mermaid
    infinisil committed Aug 13, 2023
    1 Configuration menu
    Copy the full SHA
    7ab012c View commit details
    Browse the repository at this point in the history
  25. Configuration menu
    Copy the full SHA
    9cae397 View commit details
    Browse the repository at this point in the history
  26. CONTRIBUTING.md: Move release sections together

    Will be cleaned up in the next commit
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    b665608 View commit details
    Browse the repository at this point in the history
  27. Configuration menu
    Copy the full SHA
    3639a9e View commit details
    Browse the repository at this point in the history
  28. Configuration menu
    Copy the full SHA
    4e3064d View commit details
    Browse the repository at this point in the history
  29. CONTRIBUTING.md: Remove duplicated section

    How to force push to PR's is already explained in the
    "How to propose a change" section at the beginning
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    2f345d0 View commit details
    Browse the repository at this point in the history
  30. CONTRIBUTING.md: Move rebasing section up

    Right into the "How to propose a change" section, because that's where
    it's relevant
    infinisil committed Aug 13, 2023
    Configuration menu
    Copy the full SHA
    2a99b5a View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2023

  1. Configuration menu
    Copy the full SHA
    0bd8c9b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    1665134 View commit details
    Browse the repository at this point in the history
  3. CONTRIBUTING.md: Move sections around

    Yeah I'm totally getting lazy with the commits, but it's really hard and
    takes a long time..
    infinisil committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    b069d2d View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    e630780 View commit details
    Browse the repository at this point in the history
  5. doc/README.md: Cleanup

    infinisil committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    553daae View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    15ca783 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    d5148f2 View commit details
    Browse the repository at this point in the history
  8. pkgs/README.md: Remove some mediocre duplicated sentences

    Also mainly covered in the section below
    infinisil committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    aafc9ae View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    b0f61e3 View commit details
    Browse the repository at this point in the history
  10. CONTRIBUTING.md: Minor content updates based on reviews

    - Contributing without a GitHub account
    - Mention OfBorg
    - nix.useSandbox -> nix.settings.sandbox
    - nixpkgs-review is good for not just version updates
    
    Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
    infinisil and minijackson committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    237799a View commit details
    Browse the repository at this point in the history
  11. CONTRIBUTING.md: Typos and formatting

    - Fix sentence about meeting contributing standards
    - pkgs -> packages
    - Use emoji's because GitHub renders the :*: things weird sometimes
    - Move a dot
    
    Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
    infinisil and minijackson committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    2ce1e0b View commit details
    Browse the repository at this point in the history
  12. CONTRIBUTING.md: Move boot loader-specific sentence to pkgs/README.md

    This needs a rewrite at some point..
    infinisil committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    de5a39f View commit details
    Browse the repository at this point in the history