From ba19a3d6ff20b29cfe0af63e3ea99c18b5d68184 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 15 Feb 2020 19:07:20 +0100 Subject: [PATCH] Update support channels Refs #2249 --- CONTRIBUTING.md | 19 ++++++++----------- README.md | 15 ++++++++++++--- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 594aa8b29e..f86d7d2287 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,10 +18,7 @@ First off, thanks for taking the time to contribute! ## Bug reports -We used to use Sourceforge for bug tracking, but we are in the process of moving to github issues. - -* Old bugs are still available at . -* Please report new bugs at . +We use the issue tracker on Github. Please report new bugs at . When filing a bug report, please provide as much information as possible, so that we can reproduce the issue: @@ -32,7 +29,7 @@ When filing a bug report, please provide as much information as possible, so tha ## Documentation -There is some documentation available under . Feel free to create a bug report if +There is some documentation available under . Feel free to create a bug report if documentation is missing, incomplete or outdated. See [Bug reports](#bug-reports). The documentation is generated as a Jekyll site, the source is available at: . You can find build instructions there. @@ -42,18 +39,18 @@ For more on contributing documentation check - * On [StackOverflow](https://stackoverflow.com/questions/tagged/pmd): Make sure, to tag your question with "pmd". +* Create a issue for your question at . + +* Ask your question on Gitter . + ## Code Style PMD uses [checkstyle](http://checkstyle.sourceforge.net/) to enforce a common code style. -See [pmd-checkstyle-config.xml](https://github.com/pmd/build-tools/blob/master/config/src/main/resources/net/sourceforge/pmd/pmd-checkstyle-config.xml) for the configuration and -[the eclipse configuration files](https://github.com/pmd/build-tools/tree/master/config/eclipse) that can +See [pmd-checkstyle-config.xml](https://github.com/pmd/build-tools/blob/master/src/main/resources/net/sourceforge/pmd/pmd-checkstyle-config.xml) for the configuration and +[the eclipse configuration files](https://github.com/pmd/build-tools/tree/master/eclipse) that can be imported into a fresh workspace. diff --git a/README.md b/README.md index e89fa6db57..dbfbd7d9ca 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,16 @@ Additionally it includes **CPD**, the copy-paste-detector. CPD finds duplicated C/C++, C#, Dart, Fortran, Go, Groovy, Java, JavaScript, JSP, Kotlin, Lua, Matlab, Modelica, Objective-C, Perl, PHP, PLSQL, Python, Ruby, Salesforce.com Apex, Scala, Swift and Visualforce. -## Source and Documentation +## Support + +* How do I? -- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/pmd). +* I got this error, why? -- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/pmd). +* I got this error and I'm sure it's a bug -- file an [issue](https://github.com/pmd/pmd/issues). +* I have an idea/request/question -- file an [issue](https://github.com/pmd/pmd/issues). +* I have a quick question -- ask on our [Gitter chat](https://gitter.im/pmd/pmd). +* Where's your documentation? -- + +## Source Our latest source of PMD can be found on [GitHub](https://github.com/pmd/pmd). Fork us! @@ -26,6 +35,6 @@ The rule designer is developed over at [pmd/pmd-designer](https://github.com/pmd Please see [its README](https://github.com/pmd/pmd-designer#contributing) for developer documentation. -## News and Website +## Website -More information can be found on our [Website](https://pmd.github.io) and on [SourceForge](https://sourceforge.net/projects/pmd/). +More information can be found on our [Website](https://pmd.github.io).