Skip to content

Commit

Permalink
update contributing checklist numbers to be ascending
Browse files Browse the repository at this point in the history
  • Loading branch information
shane-rosse committed Feb 25, 2025
1 parent 03f85fd commit 2a43f5c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ Checklist for contributing
--------------------------

1. Set up a `Github <https://github.com/>`_ account, if you don't have one already. We develop in the open and the public repository is the authoritative one.
1. Fork the ``garak`` repository - `<https://github.com/NVIDIA/garak/fork>`_
1. Work out what you're doing. If it's from a good first issue (`see the list <https://github.com/NVIDIA/garak/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_), drop a note on that issue so that we know you're working on it, and so that nobody else also starts working on it.
1. Before you code anything: create a new branch for your work, e.g. ``git checkout -b feature/spicy_probe``
1. Check out the rest of this page which includes links to detailed step-by-step guides to developing garak plugins
1. Code!
1. Run ``black`` on your code, so that it's well-formatted. Our github commit hook can refuse to accept ``black``-passing code.
1. Write your own tests - these are a requirement for merging!
1. When you're done, send a pull request. Github has big buttons for this and there's a template for you to fill in.
1. We'll discuss the code together with you, tune it up, and hopefully merge it in, maybe with some edits!
1. Now you're an official ``garak`` contributor, and will be permanently recognized in the project credits from the next official release. Thank you!
2. Fork the ``garak`` repository - `<https://github.com/NVIDIA/garak/fork>`_
3. Work out what you're doing. If it's from a good first issue (`see the list <https://github.com/NVIDIA/garak/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22>`_), drop a note on that issue so that we know you're working on it, and so that nobody else also starts working on it.
4. Before you code anything: create a new branch for your work, e.g. ``git checkout -b feature/spicy_probe``
5. Check out the rest of this page which includes links to detailed step-by-step guides to developing garak plugins
6. Code!
7. Run ``black`` on your code, so that it's well-formatted. Our github commit hook can refuse to accept ``black``-passing code.
8. Write your own tests - these are a requirement for merging!
9. When you're done, send a pull request. Github has big buttons for this and there's a template for you to fill in.
10. We'll discuss the code together with you, tune it up, and hopefully merge it in, maybe with some edits!
11. Now you're an official ``garak`` contributor, and will be permanently recognized in the project credits from the next official release. Thank you!



Expand Down

0 comments on commit 2a43f5c

Please sign in to comment.