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

add CONTRIBUTING.md #4741

Closed

Conversation

Disservin
Copy link
Member

No functional change

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
@vondele
Copy link
Member

vondele commented Aug 13, 2023

I think it is good to have this file, but I would prefer to keep it as concise as possible, with links to the wiki. The wiki is a better place to e.g. describe how to checkout a branch, it is also means we don't have duplicated information, and the wiki is somewhat easier to update.

There is also overlap with https://stockfishchess.org/get-involved/ so ideally these two places are also in sync.

@Disservin Disservin added to be merged Will be merged shortly and removed to be merged Will be merged shortly labels Aug 13, 2023
@Disservin Disservin force-pushed the add-contributing branch 2 times, most recently from dc4ce11 to ae7fbb3 Compare August 13, 2023 11:51
@snicolet
Copy link
Member

snicolet commented Aug 13, 2023

Looks good to me now.

Two suggestions, to make the style more similar to our Readme.md file:

  • create a link section at the bottom of the file, and use link redirections there with Markdown syntax
  • limit width of text to 80 characters, so that it can be read in a text editor

No functional change
@Disservin
Copy link
Member Author

Good suggestions, thanks.

@Disservin Disservin added the to be merged Will be merged shortly label Aug 16, 2023
@Disservin Disservin closed this in a77a844 Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants