-
Notifications
You must be signed in to change notification settings - Fork 3
Add contributing section to README #33
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.
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Contributing | ||
|
|
||
| Thank you for your interest in contributing! | ||
|
|
||
| ## License | ||
|
|
||
| By submitting a pull request or otherwise contributing to this repository, you agree that your contributions are licensed under both the **Apache 2.0** and **MIT** licenses, the same as the Osiris project itself. | ||
|
|
||
| Please ensure all commits comply with these licensing terms and include proper attribution where applicable. | ||
|
|
||
| ## How to contribute | ||
|
|
||
| 1. Fork or create a feature branch (e.g., `feature/`, `fix/`, `test/`) based on the `main` branch. | ||
| 2. Make your changes with clear, descriptive commit messages. | ||
| 3. Write tests and proofs for your changes. | ||
| 4. Ensure that all tests and all proofs pass. | ||
| 5. Run the formatter. | ||
| 6. Open a merge request with a clear description of your changes. (reference the issue that gets resolved by the PR, if any.) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.