-
-
Notifications
You must be signed in to change notification settings - Fork 124
Expand contributing guide with specific style guidelines #345
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
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -14,6 +14,10 @@ your change proposal as promptly as we can, and help you become a member of our | |||||||||||||||||||||||
| community. Everyone involved in [The Carpentries][cp-site] agrees to abide by | ||||||||||||||||||||||||
| our [code of conduct](CODE_OF_CONDUCT.md). | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### Who Should Contribute? | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Contributions to this curriculum are welcome from anyone with an interest in the project. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### How to Contribute | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| The easiest way to get started is to file an issue to tell us about a spelling | ||||||||||||||||||||||||
|
|
@@ -43,7 +47,7 @@ documentation][template-doc]. | |||||||||||||||||||||||
| to [The Workbench documentation][template-doc]. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### What to Contribute | ||||||||||||||||||||||||
| ### What to Contribute (General) | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| There are many ways to contribute, from writing new exercises and improving | ||||||||||||||||||||||||
| existing ones to updating or filling in the documentation and submitting [bug | ||||||||||||||||||||||||
|
|
@@ -58,7 +62,61 @@ are particularly valuable**: it's easy for people who have been using these | |||||||||||||||||||||||
| lessons for a while to forget how impenetrable some of this material can be, so | ||||||||||||||||||||||||
| fresh eyes are always welcome. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| ### What *Not* to Contribute | ||||||||||||||||||||||||
| ### What to Contribute (This Lesson) | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| Any contributions are welcome, particularly ideas for how the existing content could be | ||||||||||||||||||||||||
| improved or updated, and/or errors that need to be corrected. Comments on existing issues | ||||||||||||||||||||||||
| and reviews of pull requests are similarly welcome. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| If you plan to submit a pull request, please open an issue | ||||||||||||||||||||||||
| (or comment on an existing thread) first to ensure that effort is not duplicated | ||||||||||||||||||||||||
| or spent making a change that will not be accepted by the Maintainers. | ||||||||||||||||||||||||
|
|
||||||||||||||||||||||||
| #### Style / content guidelines | ||||||||||||||||||||||||
K-Meech marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||
| - If you add an image / figure that was generated from python code, please include this | ||||||||||||||||||||||||
K-Meech marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||||||||||
| ### USAGE | |
| # The script was written in Python 3.12 and required the following Python packages: | |
| # - numpy==2.2.3 | |
| # - scipy==1.15.2 | |
| # - matplotlib==3.10.1 | |
| # - tqdm==4.67.1 | |
| # | |
| # The script can be executed with | |
| # $ python create_blur_animation.py | |
| # The output animation will be saved directly in the fig folder where the markdown lesson file will pick it up | |
| ### |
for an ImageJ macro?
Uh oh!
There was an error while loading. Please reload this page.