Library of resources to be used for Architecture Designs
| Item | Description |
|---|---|
assets/ |
dir containing assets such as logo and reference info or files which are not part of the functional codebase |
.gitignore |
file which controls which files and directories are ignored by git. |
README.md |
this file |
State if you are open to contributions and what your requirements are for accepting them. For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
We use SemVer for versioning this project
See also the list of contributors who participated in this project.
If you have ideas for releases in the future, it is a good idea to list them in the README.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.