From de6444ae52f951245cfc3c10dac8d13db6d5098f Mon Sep 17 00:00:00 2001 From: erjank Date: Sat, 14 Mar 2026 15:18:47 -0600 Subject: [PATCH 1/3] Creating first draft Contributing.md Code of conduct, placeholder for PR and commit instructions. --- Contributing.md | 85 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 85 insertions(+) create mode 100644 Contributing.md diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 00000000..2701abd5 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,85 @@ +# Contributing + +When contributing to this repository, we recommend starting by making an issue, or +introducing yourself over email before submitting a pull request. + +A fun, welcoming spirit of helping to solve polymer science problems is the primary goal here. + +## Pull Request Process + +1. Update appropriate files with details of changes to interfaces, functionality. +2. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project PI at ericjankowski@boisestate.edu. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage]. + +[homepage]: http://contributor-covenant.org From 0ecd7150551697ec1161c4ec441f2551822df1bd Mon Sep 17 00:00:00 2001 From: erjank Date: Wed, 13 May 2026 15:18:06 -0600 Subject: [PATCH 2/3] Update Contributing.md Co-authored-by: Stephanie McCallum <90436933+StephMcCallum@users.noreply.github.com> --- Contributing.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Contributing.md b/Contributing.md index 2701abd5..d28cde6c 100644 --- a/Contributing.md +++ b/Contributing.md @@ -1,7 +1,6 @@ # Contributing -When contributing to this repository, we recommend starting by making an issue, or -introducing yourself over email before submitting a pull request. +When contributing to this repository, we recommend starting by making an issue before submitting a pull request. A fun, welcoming spirit of helping to solve polymer science problems is the primary goal here. From 5f20bdf3cf547723ef0baff2b1e7ec79c5bf8458 Mon Sep 17 00:00:00 2001 From: erjank Date: Wed, 13 May 2026 15:18:41 -0600 Subject: [PATCH 3/3] Update Contributing.md Co-authored-by: Stephanie McCallum <90436933+StephMcCallum@users.noreply.github.com> --- Contributing.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/Contributing.md b/Contributing.md index d28cde6c..028cc9cb 100644 --- a/Contributing.md +++ b/Contributing.md @@ -4,11 +4,28 @@ When contributing to this repository, we recommend starting by making an issue b A fun, welcoming spirit of helping to solve polymer science problems is the primary goal here. -## Pull Request Process +## Making an Issue +Please open an issue for bug reports and feature requests using the GitHub issue tracker. -1. Update appropriate files with details of changes to interfaces, functionality. -2. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. +If you are reporting a bug, please include the following information: + +* Concise description of the bug +* Expected behavior +* Actual behavior +* Steps to reproduce +* Details of your software environment + +For feature requests, please include a short description of the feature. + +## Submitting a Pull Request +We welcome code contributions in the form of pull requests. Please follow the steps below: + +* Fork the repository (default branch is main) +* Create a new branch for your feature/bug fix +* Make your changes +* Commit your changes +* Push your changes to your fork and create a pull request. In your pull request, include a short description and idenitfy any existing To-Do's. Include unit tests in your PR if your code adds new functionality. +* Assign the pull request to a reviewer and wait for the reviewers feedback ## Code of Conduct