Skip to content
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

Add more information to the contributing section especially laying out concerns for how to develop in singularity-eos and expectations for code review #209

Merged
merged 12 commits into from
Dec 16, 2022

Conversation

Yurlungur
Copy link
Collaborator

@Yurlungur Yurlungur commented Dec 14, 2022

PR Summary

I believe a recent code review caused some friction. As such I want to lay out in writing some best practices and expectations for contributing to singularity-eos. This includes:

  1. Some development concerns that should be on one's mind as one contributes to the project.
  2. Expectations for a contributor undergoing code review.
  3. Expectations for the person reviewing a pull request.

To be clear no one is at fault. However, I think having some expectations in writing that we can all point to and follow will help us interact more productively with each other going forward.

I'd like to reach out to the core team to ask for feedback on these expectations and then let's all try to follow them.

PR Checklist

  • Adds a test for any bugs fixed. Adds tests for new features.
  • Format your changes by using the make format command after configuring with cmake.
  • Document any new features, update documentation for changes made.
  • Make sure the copyright notice on any files you modified is up to date.
  • After creating a pull request, note it in the CHANGELOG.md file

…ut concerns for how to develop in singularity-eos and expectations for code review.
@Yurlungur Yurlungur added documentation Improvements or additions to documentation discussion labels Dec 14, 2022
@Yurlungur Yurlungur self-assigned this Dec 14, 2022
@Yurlungur Yurlungur mentioned this pull request Dec 14, 2022
2 tasks
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@jhp-lanl jhp-lanl left a comment

Choose a reason for hiding this comment

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

Thank you @Yurlungur for this addition! I think these are some really good points and I appreciate them being written down.

CHANGELOG.md Outdated Show resolved Hide resolved
doc/sphinx/src/contributing.rst Show resolved Hide resolved
doc/sphinx/src/contributing.rst Outdated Show resolved Hide resolved
@Yurlungur
Copy link
Collaborator Author

I think this is enough approvals. I'm going to merge it now. Thanks everyone for looking through this!

@Yurlungur Yurlungur merged commit 4343bfc into main Dec 16, 2022
@Yurlungur Yurlungur deleted the jmm/contributing-docs branch December 16, 2022 21:50
@Yurlungur
Copy link
Collaborator Author

If anyone looks at this after the fact and would like a change, please let me know. This should be a "living" document.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants