diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..77aaac2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,18 @@ +# Contributing + +Contributions are welcome through GitHub pull requests. + +## Proposing changes + +All changes to the default branch should be made through a pull request. + +1. Create a branch for the change. +2. Keep the change focused and include appropriate tests or documentation. +3. Run the relevant build, test, and formatting checks locally. +4. Open a pull request explaining the purpose of the change, how it was + verified, and any related issues. + +## Review and merge + +Pull requests should be reviewed and all required CI checks must pass before +they are merged. diff --git a/README.md b/README.md index 8ad28a1..ba0dd28 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,15 @@ # Reccaster -Reccaster is an EPICS module to facilitate the communication between IOCs and [recceiver](https://github.com/ChannelFinder/recceiver). Before `iocInit`, reccaster will publish all records and their metadata to recceiver. +This repository is still being set up as part of splitting the original +[RecSync project](https://github.com/ChannelFinder/recsync) into separately +versioned implementations and a shared protocol specification. + +Until that migration is complete, the historical +[RecCeiver server](https://github.com/ChannelFinder/recsync/tree/master/server) +remains available in the original repository. + +Reccaster is an EPICS module that facilitates communication between IOCs and +servers implementing the RecSync protocol. ## IOC Shell Functions and Variables