Skip to content

Add CONTRIBUTING file #48

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CONTRIBUTING file #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# How to Contribute

Thank you for your interest in contributing to this project.
There are many ways to contribute:

* Improve existing notebooks (e.g., fix bugs, clarify explanations, optimize code)
* Report bugs or errors
* Improve documentation or readability

## Notebook Guidelines

Most of the code in this repository is in the form of Jupyter Notebooks.
When working with notebooks, please follow these conventions:

* Avoid committing large binary blobs when possible: Unless you are directly modifying inline graphs, do not commit cells with modified large binary blobs, like matplotlib graphs.
* Check that the notebook runs online: Try running the notebook on Colab and mybinder before opening a pull request.
* Consistent Style: Follow PEP8 for Python code whenever possible and keep styling consistent.
* Reusable Code: Avoid hardcoding paths or data. Use relative paths or environment variables when possible.

## Pull Request Process

1. Fork the repository
2. Create a new feature or bug fix branch (`git checkout -b your-feature-name`)
3. Commit your changes with a clear message
4. Push to your fork (`git push origin your-feature-name`)
5. Open a Pull Request and provide a detailed description

We use GitHub Actions to check notebooks for linting and formatting, please make sure your notebook passes those checks!

Comment on lines +20 to +29
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section is a bit too technical for new users and not super useful for experienced users. So I would suppress it except the last sentence which could go in the previous section.

## Reporting Issues

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also suggest to open a discussion ? Something like "If you have questions on the content or want to suggest improvements, you can open a discussion.". Maybe we can also point people to ask.igwn.org.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not super clear but I was suggesting to add this line at the beginning of the "Reporting issue" section.

If you find a bug or have a suggestion, please open an issue.

Comment on lines +32 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the above comment, I would remove "or have a suggestion". Also, include a link to the issue page (https://github.com/gw-odw/odw/issues).

Include:

* A clear and descriptive title
* Steps to reproduce (if it's a bug)
* Code snippets, if helpful

## License

By contributing, you agree that your contributions will be licensed under the same license as this project.
Loading