Skip to content

Clarify project status and define contribution workflow #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shroffk merged 3 commits into from
Jul 30, 2026
Merged

Clarify project status and define contribution workflow #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f40aabd
Revert "Update recceiver link in README.md"
anderslindho Jul 30, 2026
d3e4173
docs: clarify repository migration status
anderslindho Jul 30, 2026
26e8a8e
docs: establish pull request workflow
anderslindho Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Loading