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

DOCS: indicate order of option items in commit message #2434

Closed
reshamas opened this issue Nov 14, 2020 · 4 comments · Fixed by #7145
Closed

DOCS: indicate order of option items in commit message #2434

reshamas opened this issue Nov 14, 2020 · 4 comments · Fixed by #7145
Labels
documentation 📜 Updates and issues with the documentation External Pull requests and issues from people who do not regularly contribute to modin P3 Very minor bugs, or features we can hopefully add some day.

Comments

@reshamas
Copy link
Contributor

The current instructions are not clear on how -s should be included in commit message. This works:
git commit -m "message" -s

file: https://github.com/modin-project/modin/blob/master/docs/CONTRIBUTING.rst

@anmyachev anmyachev added good first issue 🔰 Good for newcomers documentation 📜 Updates and issues with the documentation labels Apr 21, 2022
@mvashishtha
Copy link
Collaborator

I think the current instructions are clear enough: https://modin.readthedocs.io/en/0.15.3/development/contributing.html#certificate-of-origin-v-1-1

@reshamas
Copy link
Contributor Author

I think the current instructions are clear enough: https://modin.readthedocs.io/en/0.15.3/development/contributing.html#certificate-of-origin-v-1-1

If you say so. :)

@mvashishtha mvashishtha added Needs more information ❔ Issues that require more information from the reporter and removed good first issue 🔰 Good for newcomers labels Sep 14, 2022
@mvashishtha
Copy link
Collaborator

@reshamas thank you for responding to this issue even though it's so old!

It's a little hard to figure out what the contributing instructions said at the time you reported this issue, because the file has moved around since then. I assumed that there were no instructions about signing commits then. How could we make the current documentation clearer? I assume that readers know that command line flags for commands like git commit can appear in any order. Is that a bad assumption?

@mvashishtha mvashishtha reopened this Sep 14, 2022
@reshamas
Copy link
Contributor Author

I believe this issue was inspired by a challenge at an online sprint at PyData Global 2021 with @devin-petersohn.

Maybe the best way to see if the instructions are clear is to check again at a sprint or with new contributors. I haven't contributed to modin since last October.

@mvashishtha mvashishtha added P3 Very minor bugs, or features we can hopefully add some day. and removed Needs more information ❔ Issues that require more information from the reporter labels Sep 14, 2022
@anmyachev anmyachev added the External Pull requests and issues from people who do not regularly contribute to modin label Apr 19, 2023
anmyachev added a commit to anmyachev/modin that referenced this issue Apr 3, 2024
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
YarShev pushed a commit that referenced this issue Apr 3, 2024
Signed-off-by: Anatoly Myachev <anatoly.myachev@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 Updates and issues with the documentation External Pull requests and issues from people who do not regularly contribute to modin P3 Very minor bugs, or features we can hopefully add some day.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants