From 667c10df252d08b1a79f267e11cb7a30971bcf83 Mon Sep 17 00:00:00 2001 From: Matthew Scroggs Date: Mon, 22 Aug 2022 23:49:26 +0100 Subject: [PATCH 1/3] copy CONTRIBUTING.md from Basix --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..3940cbe3e8e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +## How to contribute + +### Reporting bugs +If you find a bug in DOLFINx, please report it on the [GitHub issue tracker](https://github.com/fenics/dolfinx/issues/new?labels=bug). + +### Suggesting enhancements +If you want to suggest a new feature or an improvement of a current feature, you can submit this +on the [issue tracker](https://github.com/fenics/dolfinx/issues). + +### Submitting a pull request +If you want to directly submit code to DOLFINx, you can do this by forking the repo, then submitting a pull request. +If you want to contribute, but are unsure where to start, have a look at the +[issues labelled "good first issue"](https://github.com/FEniCS/dolfinx/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). + +On opening a pull request, unit tests will run on GitHub CI. You can click on these in the pull request +to see where (if anywhere) the tests are failing. + +### Code of conduct +We expect all our contributors to follow the [code of conduct](CODE_OF_CONDUCT.md). Any unacceptable +behaviour can be reported to the FEniCS steering council (fenics-steering-council@googlegroups.com). From 012d39c316c7eb095e5f3dc0f7f309100f799297 Mon Sep 17 00:00:00 2001 From: Matthew Scroggs Date: Mon, 22 Aug 2022 23:50:49 +0100 Subject: [PATCH 2/3] link from readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 099f1e1569e..d60276d1d53 100644 --- a/README.md +++ b/README.md @@ -157,6 +157,10 @@ All Docker images support arm64 and amd64 architectures. For a full list of tags, including versioned images, see https://hub.docker.com/u/dolfinx +## Contributing + +Information about how to contribute to DOLFINx can be found +[here](CONTRIBUTING.md). ## License From dc12e989ecbd48001ebfd7cdf6270e2a6bdb5434 Mon Sep 17 00:00:00 2001 From: "Garth N. Wells" Date: Tue, 23 Aug 2022 10:39:50 +0100 Subject: [PATCH 3/3] Add suggestion on large PRs. Remove code of conduct email address - it's on the code of conduct document. --- CONTRIBUTING.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3940cbe3e8e..917f55e635a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,20 +1,33 @@ ## How to contribute ### Reporting bugs -If you find a bug in DOLFINx, please report it on the [GitHub issue tracker](https://github.com/fenics/dolfinx/issues/new?labels=bug). + +If you find a bug in DOLFINx, please report it on the [GitHub issue +tracker](https://github.com/fenics/dolfinx/issues/new?labels=bug). + ### Suggesting enhancements -If you want to suggest a new feature or an improvement of a current feature, you can submit this -on the [issue tracker](https://github.com/fenics/dolfinx/issues). + +If you want to suggest a new feature or an improvement of a current +feature, you can submit this on the [issue +tracker](https://github.com/fenics/dolfinx/issues). + ### Submitting a pull request -If you want to directly submit code to DOLFINx, you can do this by forking the repo, then submitting a pull request. -If you want to contribute, but are unsure where to start, have a look at the -[issues labelled "good first issue"](https://github.com/FEniCS/dolfinx/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). -On opening a pull request, unit tests will run on GitHub CI. You can click on these in the pull request -to see where (if anywhere) the tests are failing. +To contribute code DOLFINx, create a pull request. If you want to +contribute, but are unsure where to start, have a look at the [issues +labelled "good first +issue"](https://github.com/FEniCS/dolfinx/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). +For substantial changes/contributions, please start with an Issue or +start a discussion on Slack. + +On opening a pull request, unit tests will run on GitHub CI. You can +click on these in the pull request to see where (if anywhere) the tests +are failing. + ### Code of conduct -We expect all our contributors to follow the [code of conduct](CODE_OF_CONDUCT.md). Any unacceptable -behaviour can be reported to the FEniCS steering council (fenics-steering-council@googlegroups.com). + +We expect all our contributors to follow the [code of +conduct](CODE_OF_CONDUCT.md).