Making a contribution to Egeria - Step-by-Step¶
In this session, you will be guided on how to make a simple change to the Egeria project.
This change is to add a new file to the
egeria-dojo-postcards directory
and link to it in the README.md file of the same directory.
There are two videos for this session:
- How to make a contribution: https://youtu.be/vdHRtuIYwoE
- Pull Requests and testing: https://youtu.be/pMODYyPJ1b4
The Steps¶
To create your own contribution, click on each step and complete the tasks described:
-
Review the contributor guidelines to understand the requirements for an Egeria contribution.
-
Create a Git Issue. Every contribution begins with a
git issue. This describes the changes that you plan to make. The more detail that you provide, the better the maintainers will understand your contribution and be able to process it faster. -
Create a fork and clone of the git repository to bring the Egeria code onto your machine.
-
Create a new git branch to contain your change.
-
Load Egeria into your IDE so that you can see the project contents.
-
Build Egeria so it is ready to run. The link assumes you are using IntelliJ. If you prefer working with the command line try this link
-
Create your contribution - typically using the IDE. You need to create a new markdown file, add your message to the file and then add a link to the README.md file. Both of these files should use Markdown and include license and copyright statements top and bottom of the file just like this file: License File Example.
(There is more information on licences in the Contributor Guidelines.)
-
Test your changes to make sure your new function works and nothing else has broken. Since this is a document change, there should be no impact on the code - so running these tests is to check that nothing has changed by accident.
-
Add and commit changes to Git. As you commit your changes, make sure they are signed (see Why the DCO?).
-
Initiate the request to include your changes into the main branch of Egeria.
Once the PR is in place, GitHub will check the DCOs for you commits, and then run a full build on Java 17. The Egeria maintainers will review your contribution and may ask you to make changes to it. When it is acceptable, they will merge it into main and your contribution is complete.
-
Progress to Types of Contribution
-
Return to Tools for Contributors
Raise an issue or comment below