Skip to content

Adding CONTRIBUTING.md#1509

Open
phyy-nx wants to merge 3 commits into
mainfrom
contributing
Open

Adding CONTRIBUTING.md#1509
phyy-nx wants to merge 3 commits into
mainfrom
contributing

Conversation

@phyy-nx

@phyy-nx phyy-nx commented Nov 7, 2024

Copy link
Copy Markdown
Contributor

Draft of a CONTRIBUTING guide, based on conversation from the recent Telco. This guide tries to layout the existing NeXus contribution guidelines, including issue and pull request guides.

Feedback welcome.

@rayosborn

Copy link
Copy Markdown
Contributor

LGTM although I would suggest capitalizing all the words in "NeXus international advisory committee."

@phyy-nx

phyy-nx commented Nov 7, 2024

Copy link
Copy Markdown
Contributor Author

👍

@prjemian

prjemian commented Nov 7, 2024

Copy link
Copy Markdown
Contributor

In the third paragraph, please change this text from:

describes a problem and answers "why" there needs to be work done

to:

describes a problem and answers "why" work needs to be done

@phyy-nx

phyy-nx commented Nov 8, 2024

Copy link
Copy Markdown
Contributor Author

Done. I purport this is merely echoing the constitution and established practices and therefore doesn't need a vote, but disagreement is welcome.

@lukaspie

lukaspie commented Jun 4, 2025

Copy link
Copy Markdown
Contributor

In today's Telco, it was discussed that the preferred way of merging PR is doing a squash commit. This prevents the situation in #1424, where a couple hundreds a small commits were added to the history of the main branch. This had to be resolved in #1566 manually.

I think it would be a good idea to state this here explicitly (and also make squash commits the default in the settings, as @PeterC-DLS wanted to set it up).

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.

4 participants