Thank you for considering contributing to ifml2php, your contributions are welcome via Github pull requests. There is plenty of work to do and we need your help to make an useful, efficient and nice to use tool. Following these guidelines helps save your time and ours, please feel free to propose changes to this document in a pull request. We are eager for your contributions:
- Writing and refactoring code
- Improving documentation
- Writing tutorials
- Blogging posts
- Spreading the project
- Check for overlap with other Pull Requests.
- Think carefully about the long-term implications of the change. How will it affect existing projects that are dependent on this? How will it affect my projects? If this is complicated, do I really want to maintain it forever? Is there any way it could be implemented as a separate package, for better modularity and flexibility?
- Don't add any classes to the metamodel unless absolutely needed
- Review the changes carefully, line by line. Make sure you understand every single part of every line. Learn whatever you do not know yet.
- Take the time to get things right. PRs almost always require additional improvements to meet the bar for quality. Be very strict about quality. This usually takes several commits on top of the original PR.
- Write or request the needed docs.
- Ensure back-ward compatibility for every change that's accepted
- Add name and URL of the authors.
If you find a security vulnerability, do NOT open an issue. Email ifml2php@gmail.com instead.
It will be useful if you tell us:
- What version of version of Eclipse, ATL, Acceleo or Java are you using?
- What operating system and processor architecture are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?