Skip to content

Commit a0f966d

Browse files
authored
Update CONTRIBUTING.md (#346)
* Update CONTRIBUTING.md To include guidance for new notebooks Addressed Michael's feedback
1 parent 56857be commit a0f966d

File tree

1 file changed

+32
-23
lines changed

1 file changed

+32
-23
lines changed

CONTRIBUTING.md

+32-23
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,26 @@
11
# Contributing Guidelines
2-
3-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
2+
Thank you for your interest in contributing to the graph-notebook project! Whether it's a bug report, new feature, new notebook, correction, or additional
43
documentation, we greatly value feedback and contributions from our community.
54

6-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7-
information to effectively respond to your bug report or contribution.
8-
5+
Before reporting a bug/feature request, or creating a pull request, please ensure that:
96

10-
## Reporting Bugs/Feature Requests
7+
1. You have checked there aren't already open or recently closed issues/pull requests for your request.
8+
2. You are working against the latest source on the `main` branch.
9+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
1110

12-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
11+
## Security Issue Notifications
12+
If you discover a potential security issue in this project, we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please **do not** create a public Github issue.
1313

14-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
14+
## Reporting Bugs/Feature Requests
15+
We welcome you to use the GitHub issue tracker to report bugs or suggest features. Please try to include as much information as you can. Details like the following are incredibly useful:
1616

1717
* A reproducible test case or series of steps
1818
* The version of our code being used
1919
* Any modifications you've made relevant to the bug
2020
* Anything unusual about your environment or deployment
2121

22-
23-
## Contributing via Pull Requests
24-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25-
26-
1. You are working against the latest source on the *main* branch.
27-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
22+
## Contributing code via Pull Requests
23+
Contributions via pull requests are much appreciated.
2924

3025
To send us a pull request, please:
3126

@@ -34,26 +29,40 @@ To send us a pull request, please:
3429
3. Ensure local tests pass.
3530
4. Commit to your fork using clear commit messages.
3631
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
32+
6. In your local branch, modify the “Upcoming” section in the ChangeLog.md file with a new entry that includes a brief description of your changes, as well as a link to the open pull request (see sample format below). Push the ChangeLog update to the pull request branch.
33+
34+
`- Added a change. ([Link to PR](https://github.com/aws/graph-notebook/pull/1))`
35+
36+
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3837

3938
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4039
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4140

41+
## Contributing sample notebooks via Pull Requests
42+
We welcome any new contributions on how to use the graph-notebook to solve real-world graph problems! Before sending us a pull request, please open an issue to discuss your notebook idea. Here are some additional guidelines to expedite the review process:
43+
44+
1. **Use of sample data and images:** You will be asked to verify the licensing of your data and images. ** For data, provide a way for the notebook to be able to programmatically download the data within a cell. For images, provide a hosted link (e.g., Amazon S3, CloudFront). We try to keep the package size of graph-notebook small so no data or images should be part of the pull request.
45+
46+
2. **Standalone tutorials:** Our sample notebooks typically automate as much as possible using sample configurations and commands within Cells. The idea is that a user can run through a sample notebook with minimal required inputs and configuration outside of the notebook. *For Amazon Neptune tutorials: provide a way or advise the user to create a new Neptune cluster for the tutorial with desired configurations as applicable.*
47+
48+
3. **Naming/numbering of notebooks:** Our notebooks typically follow some themes, such as by language, by business application, or by feature. Before merging, check with a graph-notebook admin to come up with an agreed folder-path and naming.
49+
50+
4. **Running cells:** Provide a brief explanation for each cell on the purpose of running the cell and expected result. For example, after running a `%seed` command on a sample dataset, add a follow-up cell with a graph query to show how many nodes/edges were added and write the expected numbers to compare to.
51+
52+
5. **Cleaning up:** Provide a way (and be extra careful) to **ONLY** delete the data and resources created as part of tutorial, once the tutorial concludes.
53+
54+
6. **Testing:** During testing, each cell should output expected results successfully using the provided configurations, to be validated by a reviewer.
55+
56+
7. **Structure:** For longer sample notebooks, include a Table of Contents to help users quickly navigate. Create a Conclusion section and provide calls-to-action that users can follow-up on the specific topics if they want to learn more.
4257

4358
## Finding contributions to work on
4459
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
4560

46-
4761
## Code of Conduct
4862
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
4963
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
5064
[email protected] with any additional questions or comments.
5165

52-
53-
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55-
56-
5766
## Licensing
5867

5968
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

0 commit comments

Comments
 (0)