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

Adding code of conduct and development documentation #28

Merged

Conversation

gvegayon
Copy link
Collaborator

This pull request includes significant updates to the project's documentation, focusing on the Code of Conduct and development guidelines. The most important changes include the addition of a comprehensive Code of Conduct, updates to the development documentation, and modifications to the README file to reference these new documents.

Documentation Updates:

  • CODE_OF_CONDUCT.md: Added a detailed Contributor Covenant Code of Conduct, outlining community standards, enforcement responsibilities, and guidelines for addressing unacceptable behavior.

  • DEVELOPMENT.md: Introduced new development documentation, including guidelines for contributing, instructions for installing pre-commit hooks, and notes for building the container image.

README Modifications:

  • README.md: Updated to include a reference to the new Code of Conduct and a link to the development guidelines. Removed the section on building the container image, which is now covered in DEVELOPMENT.md.

@gvegayon gvegayon requested a review from apulsipher as a code owner October 25, 2024 17:24
@gvegayon gvegayon linked an issue Oct 25, 2024 that may be closed by this pull request
@gvegayon
Copy link
Collaborator Author

@apulsipher, some links in the DEVELOPMEN.md file are broken but should be OK once this is merged. If not, we can create an issue to address that after we merge this.

Copy link
Collaborator

@apulsipher apulsipher left a comment

Choose a reason for hiding this comment

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

Two things to fix, but otherwise looks great.

@gvegayon
Copy link
Collaborator Author

I like both of your suggestions. Please fix them yourself, approve, and merge. Thanks!

Copy link
Collaborator

@apulsipher apulsipher left a comment

Choose a reason for hiding this comment

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

lgtm

@apulsipher apulsipher merged commit b8e8bd1 into main Oct 30, 2024
3 checks passed
@apulsipher apulsipher deleted the 17-update-readme-to-include-details-on-running-pre-commit branch October 30, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README to include details on running pre-commit
2 participants