Contributing

Welcome to the phoebus-fnal! 😄

Introduction

As with all contributions to the Fermilab EPICS code base, one must acquire a github enterprise account so that your code may be merged with the standard deployment.

Furthermore, one must be added as a member of the epics-controls project; to become a member, please make a request to either Denise Finstrom ([email protected]), Mariana González ([email protected]), or Pierrick Hanlet ([email protected]).

Local development

Install prerequisites

1. Clone the repository

   git clone [email protected]:fermi-ad/phoebus-fnal.git

2. Working from a group account? Set your name and email

cd phoebus-fnal
git config user.name "My Name"
git config user.email "[email protected]"`

3. Configure and install the build dependencies: Java 11 and MVN 3.8 (or later)

4. The maven build process involves contacting the primary Phoebus repo on GitHub.com, so you need access to the outside world. On a separate terminal, create a tunnel to outland or outback with your personal username:

   ssh -fN -D 1080 $USER@outback

Development

5. Create a new branch, use the branch naming convention feature-abc or bugfix-xyz:

   git checkout -b feature-abc

    gitGraph
       commit
       commit
       branch feature-abc
       commit
       commit
       commit
       checkout main

Loading

6. Make your changes, refer to README.md for more details about the repo structure and adding new code.

7. Build

   proxychains ./build.sh |& build.log

8. Test your changes

   ./run-phoebus.sh

9. Commit and push your changes

  git add [files]
  git -m "comments" commit
  git push

9. Create a Pull request