Single Source of truth for contributing guidelines

[Nils-ChristianIseke]

We should have a single source of truth for the contributing guidelines.

[fujitatomoya]

in general, i agree with this approach to reduce the maintenance cost and redundancy. (we redeploy the documentation nightly as described here, so it would not be problem.)

there is a couple of suggestions.

[kscottz]

I am really ambivalent about this pull request but I am not going to get in the way on it getting merged. I get that we should aim for "DRY" but I also think you can take certain rules a little too far.

Is it too much to ask that less README.MD on the repo you just cloned actually contains instructions on how to build the repository? Maybe just an abridged version of the instructions?

[kscottz]

I don't know if we necessarily want to frame this as solely contributing versus "building and contributing."

[Nils-ChristianIseke]

Thank you for your review. I came across this because the documentation deviated from the instructions in the readme file. And one part of the information in the documentation was incorrect. However, I agree with you that having that information in the README is not bad. I could check if it is possible to integrate the parts of the rst into this markdown or vice versa.

[Nils-ChristianIseke]

@fujitatomoya @kscottz friendly ping :).
Some alternatives I currently see:

1. Close this PR
2. Align the README and Contribution Guidelines (duplicate content)
3. Remove this from the README and keep only in the Docs
4. Remove this from the Docs and only keep it in the README
5. Establish a single source of truth by keeping the content in one file and including it in both locations (e.g., importing .rst into .md or vice versa), though I'm uncertain about the implementation complexity.

Happy for your thoughts :)

[fujitatomoya]

I say keeping this PR 👍

@kscottz what do you think?

[fujitatomoya]

@Mergifyio rebase

[mergify]

rebase

❌ Base branch update has failed

Details

Git reported the following error:

Rebasing (1/6)
Auto-merging README.md
CONFLICT (content): Merge conflict in README.md
error: could not apply 14fe343... Update README.md
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply 14fe343... Update README.md

[fujitatomoya]

@Nils-ChristianIseke sorry for being late to get back to you. can you rebase this against current rolling branch?

[fujitatomoya]

it just says No changes to show... can you check?