You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.
It should, an apt oneliner working at least on debian/ubuntu could be added to the CONTRIBUTING.md. Note: I would rather have composer installed locally instead (from my experience).
In my opinion, feel free to choose the name you prefer, but I think having all installation steps in one place would be beneficial to new contributors, and currently some steps are in README.md. So if you choose to put some information elsewhere, you should also considering migrating or removing the part which is in README.md.
Moreover, a link / reference to where install instructions can be found should be added in the README.md file if you choose to put these information elsewhere, as it is the first thing that you read when you open the github repo.
Generally a CONTRIBUTING.md file does not contain technical information but a Code of Conduct and/or what are the dev processes. Like how you should submit a pull request, etc.
Some times install instructions can be found in an INSTALL.md file, or you can even start a standalone documentation in a doc/ folder with sphinx
Tested on the lastest Debian 9 (9.5) and Ubuntu 16 LTS (16.04).
Before proceding for contributing, the following packages must be installed :
Should it be added to CONTRIBUTING.md or README.md ?
The text was updated successfully, but these errors were encountered: