diff --git a/doc/src/Modify_contribute.rst b/doc/src/Modify_contribute.rst index ed2ef783f4..8bc320a9b0 100644 --- a/doc/src/Modify_contribute.rst +++ b/doc/src/Modify_contribute.rst @@ -1,37 +1,51 @@ Submitting new features for inclusion in LAMMPS =============================================== -We encourage users to submit new features or modifications for LAMMPS -to `the core developers `_ so they -can be added to the LAMMPS distribution. The preferred way to manage -and coordinate this is as of Fall 2016 via the LAMMPS project on -`GitHub `_. An alternative is to -contact the LAMMPS developers or the indicated developer of a package -or feature directly and send in your contribution via e-mail. +We encourage users to submit new features or modifications for LAMMPS to +`the core developers `_ so they +can be added to the LAMMPS distribution. The preferred way to manage and +coordinate this is via the LAMMPS project on `GitHub +`_. Please see the :doc:`GitHub +Tutorial ` for a demonstration on how to do that. An +alternative is to contact the LAMMPS developers or the indicated +developer of a package or feature directly and send in your contribution +via e-mail, but that can add a significant delay on getting your +contribution included, depending on how busy the developer is you +contact, how complex a task it would be to integrate that code, and how +many - if any - changes are required before the code can be included. -For any larger modifications or programming project, you are -encouraged to contact the LAMMPS developers ahead of time, in order to -discuss implementation strategies and coding guidelines, that will -make it easier to integrate your contribution and result in less work -for everybody involved. You are also encouraged to search through the -list of `open issues on GitHub `_ and submit a new issue -for a planned feature, so you would not duplicate the work of others -(and possibly get scooped by them) or have your work duplicated by -others. +For any larger modifications or programming project, you are encouraged +to contact the LAMMPS developers ahead of time, in order to discuss +implementation strategies and coding guidelines, that will make it +easier to integrate your contribution and result in less work for +everybody involved. You are also encouraged to search through the list +of `open issues on GitHub `_ +and submit a new issue for a planned feature, so you would not duplicate +the work of others (and possibly get scooped by them) or have your work +duplicated by others. -How quickly your contribution will be integrated depends largely on -how much effort it will cause to integrate and test it, how much it -requires changes to the core codebase, and of how much interest it is -to the larger LAMMPS community. Please see below for a checklist of -typical requirements. Once you have prepared everything, see the -:doc:`Using GitHub with LAMMPS Howto ` doc page for instructions on how to -submit your changes or new files through a GitHub pull request. If you -prefer to submit patches or full files, you should first make certain, -that your code works correctly with the latest patch-level version of -LAMMPS and contains all bug fixes from it. Then create a gzipped tar -file of all changed or added files or a corresponding patch file using -'diff -u' or 'diff -c' and compress it with gzip. Please only use gzip -compression, as this works well on all platforms. +For informal communication with (some of) the LAMMPS developers you may +ask to join the `LAMMPS developers on Slack `_. +This slack work space is by invitation only. Thus for access, please +send an e-mail to ``slack@lammps.org`` explaining what part of LAMMPS +you are working on. Only discussions related to LAMMPS development are +tolerated, so this is **NOT** for people that look for help with compiling, +installing, or using LAMMPS. Please contact the `lammps-users mailing +list `_ for those purposes instead. + +How quickly your contribution will be integrated depends largely on how +much effort it will cause to integrate and test it, how much it requires +changes to the core codebase, and of how much interest it is to the +larger LAMMPS community. Please see below for a checklist of typical +requirements. Once you have prepared everything, see the :doc:`Using +GitHub with LAMMPS Howto ` doc page for instructions on +how to submit your changes or new files through a GitHub pull +request. If you prefer to submit patches or full files, you should first +make certain, that your code works correctly with the latest patch-level +version of LAMMPS and contains all bug fixes from it. Then create a +gzipped tar file of all changed or added files or a corresponding patch +file using 'diff -u' or 'diff -c' and compress it with gzip. Please only +use gzip compression, as this works well on all platforms. If the new features/files are broadly useful we may add them as core files to LAMMPS or as part of a :doc:`standard package `. Else we will add them as a