Edit me

Every volunteer project obtains its strength from the people involved in it. We invite you to participate as much or as little as you choose.

You can:

  • Use our project and provide a feedback.
  • Provide us with the use-cases.
  • Report bugs and submit patches.
  • Contribute code, javadocs, documentation.

Visit the Contributing page for general Apache contribution information. If you plan to make any significant contribution, you will need to have an Individual Contributor License Agreement (ICLA) on file with Apache.

Mailing list

Get help using Edgent or contribute to the project on our mailing lists:

Issue tracker

We use JIRA here: https://issues.apache.org/jira/browse/EDGENT

Bug reports

Found a bug? Create an issue in JIRA.

Before submitting an issue, please:

  • Verify that the bug does in fact exist
  • Search the issue tracker to verify there is no existing issue reporting the bug you've found
  • Consider tracking down the bug yourself in the Edgent source and submitting a pull request along with your bug report. This is a great time saver for the Edgent developers and helps ensure the bug will be fixed quickly.

Feature requests

Enhancement requests for new features are also welcome. The more concrete the request is and the better rationale you provide, the greater the chance it will incorporated into future releases. To make a request, create an issue in JIRA.

Source code

The project sources are accessible via the source code repository which is also mirrored in GitHub.

When you are considering a code contribution, make sure there is a JIRA issue that describes your work or the bug you are fixing. For significant contributions, please discuss your proposed changes in the issue so that others can comment on your plans. Someone else may be working on the same functionality, so it's good to communicate early and often. A committer is more likely to accept your change if there is clear information in the issue.

To contribute, fork the mirror and issue a pull request. Put the JIRA issue number, e.g. EDGENT-100 in the pull request title. The tag [WIP] can also be used in the title of pull requests to indicate that you are not ready to merge but want feedback. Remove [WIP] when you are ready for merge. Make sure you document your code and contribute tests along with the code.

Read DEVELOPMENT.md at the top of the code tree for details on setting up your development environment.

Website and documentation source code

The project website and documentation sources are accessible via the website source code repository which is also mirrored in GitHub. Contributing changes to the website and documentation is similar to contributing code. Follow the instructions in the Source Code section above, but fork and issue a pull request against the website mirror. Follow the instructions in the top-level README.md for details on contributing to the website and documentation.

You will need to use Markdown and Jekyll to develop pages. See: