Thanks for being interested in contributing to Lincoln! Lincoln is Temando's first major open source project so bear with us while we iron out the kinks. The following describes some basic information that should help you get started.
Lincoln aims to support evergreen browsers, such as Chrome, Firefox, Safari and IE10+. While the project does not currently implement a responsive design, it will do in the future.
Lincoln is written adhering to the StandardJS code style. ESLint is used to enforce standard and standard-react rule sets.
Lincoln uses Jest for testing. Tests should be committed with each code change to ensure regressions do not occur.
Test coverage is not currently enforced, but it will be in the future.
We prefer small, focused MR's rather than large complex MR's whenever possible.
We use Github projects to manage phases of development. If you'd like to chip in:
- Open a project and look at the TODO column for unassigned work. Generally it's in priority order.
- Leave a note on the issue saying you'd like to tackle it.
- Create a new branch in your fork and begin!
- When raising the MR, include as much detail as possible to help the reviewer
Alternatively, sometimes we have ideas that we are not sure how to approach, or don't fit in with our priorities. These issues are labelled as wishes. Feel free to tackle one of these or contribute any feedback.
Lincoln will, in future, abide to semver and keep a changelog. Right now we are at the peak of development and until we reach a release, these processes would add extra overhead that we are not willing to absorb just yet.