Over the years, tests and documentation have sometimes been sacrificed in order to speed up the development process. As result, not all of the modules had tests or documentation. When there were only two or three developers, the lack of tests wasn't such a big issue. They knew the code very well and the risk of regressions was relatively low. However, when more and more contributors were involved, this stopped working and made it harder and harder to keep the library in good condition.
As a result, we have instituted new policies related to the tests and documentation which have recently been added to AlloyUI. We would love to share them with you:
First of all, you should know that we're not using the GitHub Issues, instead we use Jira. In order for us to help you please check that you've completed the following steps:
- Make sure that you're using the latest version.
- Look through the list of issues to ensure that the bug hasn't been reported before.
If you're still facing the problem, go ahead and create an issue. Just remember to include as much information about the bug as possible.
This project uses single-quotes, four space indentation and whitespace around arguments. Please ensure any pull requests follow this closely by using the EditorConfig file and linting your code with our JSHint options. If you notice existing code which doesn't follow these practices, feel free to shout out and we will change it.
No single commit should go to AlloyUI source tree without tests. Exceptions are allowed for some source formatting (like renaming variables or converting spaces to tabs, etc.), but for each bugfix or for each feature added, tests must be present.
All code should be properly documented using YUIDoc syntax. Documentation should be considered as part of the code.
The changes should be described in HISTORY.md file which every module has, so it is easy to track which changes have been added between two versions.
In short, that is it! We would highly appreciate if you help us in the process of creating tests and documentation. There is no better way to get involved in this great project!
Happy hacking!