Annotate

CONTRIBUTING @ 11148:1dc49accb58e

core.moduleapi: Return resource path from module:get_directory() (API BC) :get_directory has so far returned the base directory of the current module source code. This has worked well so far to load resources which tend to be included in the same directory, but with the plugin installer using LuaRocks, extra resources (e.g. templates and other assets) these are saved in a completely different directory. In be73df6765b9 core.modulemanager gained some code for finding that directory and saving it in module.resource_path but now the question is how this should be reflected in the API. A survey of community modules suggest the vast majority use the :get_directory method for locating templates and other assets, rather than the code (which would use module:require instead). Therefore this commit changes :get_directory to return the resource_path when available. This should work for most modules.
author Kim Alvefur <zash@zash.se>
date Fri, 09 Oct 2020 16:37:15 +0200
parent 9946:ceaca48a7e6d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9946
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 Thanks for your interest in contributing to the project!
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 There are many ways to contribute, such as helping improve the
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 documentation, reporting bugs, spreading the word or testing the latest
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 development version.
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 You can find more information on how to contribute at <https://prosody.im/doc/contributing>
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
ceaca48a7e6d CONTRIBUTING: Add a short file referencing the online doc/contributing page
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 See also the HACKERS and README files.