How to Contribute
Getting Started
- Fork the repository on GitHub to publish any proposed changes
- Submit a ticket for your issue at LexEVS Tracker, assuming one does not already exist.
- If need be create a JIRA account here: JIRA accounts
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
Making Changes
Create a topic branch from where you want to base your work.
- LexEVS source code is found here.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on master: git checkout -b fix/master/my_contribution master
- Please avoid working directly on the master branch.
- Make commits of logical units.
- Please provide tests and documentation with your changes.
- Check for unnecessary whitespace with ``git diff --check`` before committing.
- Follow the NCIP Good Practices for Commit Messages.
- Start with a one-line summary followed by a blank line followed by a detailed free-form description.
Submitting Changes
- In general, we require that the OSI-approved `BSD 3-Clause License` be applied to code contributions. In the case of LexEVS the EPL license from Eclipse is applied.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the LexEVS repository in the NCIP organization.
- Update your JIRA ticket to mark that you have submitted code and are ready for it to be reviewed.
Additional Resources