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.

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

Jump to bottom

feat(upgrade): add numfocus coc option #219

Merged
merged 7 commits into from
Feb 23, 2024
Merged

feat(upgrade): add numfocus coc option #219

merged 7 commits into from
Feb 23, 2024

Conversation

YurelyCamacho
Copy link
Collaborator

Pull Request description

Adding the option to the template for the Numfocus code of conduct.

  • Add option to cookiecutter.json file.
  • Add file NUMFOCUS_adapted_coc.md
  • Add option to files smoke test
  • Upgrade post_gen_project file
  • Add option in profiles

Solve #142

Pull Request checklists

This PR is a:

  • bug-fix
  • new feature
  • maintenance

About this PR:

  • it includes tests.
  • the tests are executed on CI.
  • the tests generate log file(s) (path).
  • pre-commit hooks were executed locally.
  • this PR requires a project documentation update.

Author's checklist:

  • I have reviewed the changes and it contains no misspelling.
  • The code is well commented, especially in the parts that contain more complexity.
  • New and old tests passed locally.

Reviewer's Checklist

  • I managed to reproduce the problem locally from the main branch
  • I managed to test the new changes locally
  • I confirm that the issues mentioned were fixed/resolved

@YurelyCamacho YurelyCamacho requested a review from xmnlab February 23, 2024 01:40
xmnlab
xmnlab requested changes Feb 23, 2024
View reviewed changes
Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

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

@YurelyCamacho , thanks for working on that.
in general that looks good to me.
just added a few suggestions

src/scicookie/cookiecutter.json Outdated
@@ -33,7 +33,8 @@
"code_of_conduct": [
"None",
"contributor-covenant",
"citizen-code-of-conduct"
"citizen-code-of-conduct",
"NumFOCUS-adapted-coc"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"NumFOCUS-adapted-coc"
"numfocus-adapted-coc"

as this is just key, we can keep it in lower case

src/scicookie/{{cookiecutter.project_slug}}/coc/NUMFOCUS_adapted_coc.md Outdated
@@ -0,0 +1,231 @@
# NumFOCUS-Adapted Code of Conduct
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# NumFOCUS-Adapted Code of Conduct
# {{ cookiecutter.project_name }} Code of Conduct

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Here I have doubts because the other files that are as coc options, the name appears as I placed it. That is why I did it this way. But I am going to change it

src/scicookie/{{cookiecutter.project_slug}}/coc/NUMFOCUS_adapted_coc.md Outdated

Reports are sent to the {{ cookiecutter.project_name }} Code of Conduct Enforcement Team (see below).

<!-- If you are using TypeForm, leave the following text in place -->
Copy link
Member

Choose a reason for hiding this comment

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

I think that you could remove this comment and the paragraph above about the privacy policy ...
maybe you can just add a note, something like : if the form you are using has any privacy policy, please add a paragraph about that with the link.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I don't understand which paragraph you are referring to

Copy link
Member

Choose a reason for hiding this comment

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

You can view the Privacy Policy and Terms of Service for TypeForm at https://terms.typeform.com/to/fJAmVc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It's ready

src/scicookie/{{cookiecutter.project_slug}}/coc/NUMFOCUS_adapted_coc.md Outdated

<!-- If you are using TypeForm, leave the following text in place -->

You can view the Privacy Policy and Terms of Service for TypeForm at [*https://terms.typeform.com/to/fJAmVc*](https://terms.typeform.com/to/fJAmVc).
Copy link
Member

Choose a reason for hiding this comment

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

see comment above

xmnlab
xmnlab approved these changes Feb 23, 2024
View reviewed changes
Copy link
Member

@xmnlab xmnlab left a comment

Choose a reason for hiding this comment

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

LGTM! thanks for working on that @YurelyCamacho

@xmnlab xmnlab merged commit 177df05 into osl-incubator:main Feb 23, 2024
11 checks passed
@YurelyCamacho YurelyCamacho deleted the 142-add-numfocus-coc branch February 23, 2024 23:15
@YurelyCamacho YurelyCamacho restored the 142-add-numfocus-coc branch February 28, 2024 18:17
@github-actions GitHub Actions
Copy link

🎉 This PR is included in version 0.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

YurelyCamacho added a commit to YurelyCamacho/cookiecutter-python that referenced this pull request Dec 27, 2024
@YurelyCamacho
feat(upgrade): add numfocus coc option (osl-incubator#219)
f6d8bc7
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xmnlab xmnlab xmnlab approved these changes

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@YurelyCamacho @xmnlab