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

Add maintainers to pyproject.toml & update CONTRIBUTING.md with ruff setup for IDEs (#173 and #163) #230

Merged
merged 4 commits into from
Jul 10, 2024
Merged

Add maintainers to pyproject.toml & update CONTRIBUTING.md with ruff setup for IDEs (#173 and #163) #230

merged 4 commits into from
Jul 10, 2024

Conversation

nijanthanvijayakumar
Copy link
Contributor

@nijanthanvijayakumar nijanthanvijayakumar commented Jul 7, 2024 •
edited
Loading

Proposed changes

Related to #173, add maintainers to pyproject.toml file

  • Add a maintainers section below the authors section.
  • Include the names and contact information of the maintainers (first version only).
  • Use the format name <email> for each maintainer.
  • Add a comment above the maintainers section to indicate its purpose.

Related to #163, following changes have been made in the file:

  • Remove mention of Black from the CONTRIBUTING.md
  • Add instructions on how to add ruff to VSCode
  • Add instructions on how to add ruff to PyCharm

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (if none of the other choices apply)

Further comments

  • Since I was working on two issues and merged them to the main branch on the repo I forked, both the changes have started to appear in this PR. Hence, closes the issues Add ruff format for auto formation of code #163 and Add maintainers to pyproject.toml #173 .
  • Regarding the maintainers update, I have added only @SemyonSinchenko to the maintainers list for now. Please let me know if any others should be added to the list in this same PR. PR checks/GitHub actions have passed when I tried merging to my master/main branch. Kindly review & merge.

@nijanthanvijayakumar
Issue 173 add maintainers (#2)
f29c928 
Related to mrpowers-io#173

Add maintainers to `pyproject.toml` file

* Add a `maintainers` section below the `authors` section.
* Include the names and contact information of the maintainers (first version only).
* Use the format `name <email>` for each maintainer.
* Add a comment above the `maintainers` section to indicate its purpose.
@nijanthanvijayakumar
Copy link
Contributor Author

@MrPowers and @SemyonSinchenko - please let me know the list of maintainers of this project, so that I can update the pyproject.toml with that list.

Also, let me know if this section in CONTRIBUTING.md file should also be updated with that relevant list?

@nijanthanvijayakumar
Describe how to add ruff in IDEs like VSCode & PyCharm (#3)
29f67da 
* Describe how to add ruff in IDEs like VSCode & PyCharm

Following changes have been made in the file(s):
* **CONTRIBUTING.md**
  - Remove mention of Black
  - Add instructions on how to add ruff to VSCode
  - Add instructions on how to add ruff to PyCharm
@nijanthanvijayakumar nijanthanvijayakumar changed the title Add maintainers to pyproject.toml (#173) Add maintainers to pyproject.toml & update CONTRIBUTING.md with ruff setup for IDEs (#173 and #163) Jul 8, 2024
SemyonSinchenko
SemyonSinchenko approved these changes Jul 8, 2024
View reviewed changes
Copy link
Collaborator

@SemyonSinchenko SemyonSinchenko left a comment

Choose a reason for hiding this comment

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

LGTM

@SemyonSinchenko
Copy link
Collaborator

Also, let me know if this section in CONTRIBUTING.md file should also be updated with that relevant list?

We can delete this section because from now we have this information in pyproject.toml. @MrPowers @jeffbrennan what do you think?

@nijanthanvijayakumar
Copy link
Contributor Author

nijanthanvijayakumar commented Jul 8, 2024 •
edited
Loading

Also, let me know if this section in CONTRIBUTING.md file should also be updated with that relevant list?

We can delete this section because from now we have this information in pyproject.toml. @MrPowers @jeffbrennan what do you think?

Ok once confirmed by @MrPowers and @jeffbrennan, I will delete this section from the CONTRIBUTING.md to update this PR.

MrPowers
MrPowers approved these changes Jul 8, 2024
View reviewed changes
Copy link
Collaborator

@MrPowers MrPowers 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!

@nijanthanvijayakumar nijanthanvijayakumar mentioned this pull request Jul 8, 2024
Merged
@SemyonSinchenko
Copy link
Collaborator

@nijanthanvijayakumar ping me when you are done and I will merge it.

@nijanthanvijayakumar
Copy link
Contributor Author

nijanthanvijayakumar commented Jul 8, 2024 •
edited
Loading

@nijanthanvijayakumar ping me when you are done and I will merge it.

Hello @SemyonSinchenko - I'm done with the changes. Thought I was supposed to wait for @jeffbrennan's approval. Please merge it if you can?

@nijanthanvijayakumar
Copy link
Contributor Author

@SemyonSinchenko - are you able to merge this PR?

@SemyonSinchenko SemyonSinchenko merged commit f037947 into mrpowers-io:main Jul 10, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MrPowers MrPowers MrPowers approved these changes

@SemyonSinchenko SemyonSinchenko SemyonSinchenko approved these changes

@jeffbrennan jeffbrennan Awaiting requested review from jeffbrennan

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

Successfully merging this pull request may close these issues.
3 participants
@nijanthanvijayakumar @SemyonSinchenko @MrPowers