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 a CONTRIBUTING.md #42

Open
MakisH opened this issue Dec 16, 2020 · 2 comments
Open

Add a CONTRIBUTING.md #42

MakisH opened this issue Dec 16, 2020 · 2 comments

Comments

@MakisH
Copy link
Member

MakisH commented Dec 16, 2020

This repository already has a .clang-format, integration with the system tests, etc. It would be nice to have all these as requirements/instructions in a CONTRIBUTING.md file, similar to the one in preCICE: https://github.com/precice/precice/blob/develop/docs/CONTRIBUTING.md

@davidscn
Copy link
Member

The adapter follows (to my best knowledge) the deal.II contributing guideline. I would refer to their contributing file.

@MakisH
Copy link
Member Author

MakisH commented Dec 17, 2020

This is also fine, but we need to document this somewhere.

Since the deal.II CONTRIBUTING.md does not mention how to run clang-format (or anything else that we may require), I would prefer to have some explicit instructions and anything else that we may require.

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

No branches or pull requests

2 participants