Merge branch 'release/0.4.12'

Contributing.md

@@ -0,0 +1,66 @@
+# Contributing to Casper Bridge Smart Contracts
+
+Thank you for considering contributing to Casper Bridge Smart Contracts! We appreciate your interest in improving our project. Please take a moment to review the following guidelines to ensure a smooth and effective collaboration.
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [How to Contribute](#how-to-contribute)
+- [Bug Reports](#bug-reports)
+- [Feature Requests](#feature-requests)
+- [Pull Requests](#pull-requests)
+- [Style Guidelines](#style-guidelines)
+- [License](#license)
+
+## Code of Conduct
+
+We have adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors to follow. Please make sure to review and adhere to this code to foster a positive and inclusive community.
+
+## How to Contribute
+
+There are several ways to contribute to Casper Bridge Smart Contracts, including:
+
+1. [Bug reports](#bug-reports) - Help us identify and fix issues.
+2. [Feature requests](#feature-requests) - Suggest new ideas and improvements.
+3. [Pull requests](#pull-requests) - Contribute code directly to the project.
+
+## Bug Reports
+
+If you encounter any issues or bugs while using Casper Bridge Smart Contracts, please submit a detailed bug report. You can do this by following these steps:
+1. Verify that the bug has not been reported yet by searching through the [existing issues](https://github.com/ferrumnet/bridge-casper-smart-contracts/issues).
+2. If the bug hasn't been reported, [open a new issue](https://github.com/ferrumnet/bridge-casper-smart-contracts/issues/new) and provide a clear title and description of the problem.
+3. Include steps to reproduce the bug, along with any relevant error messages or screenshots.
+4. If possible, suggest a possible fix or a way to mitigate the problem.
+
+## Feature Requests
+
+We welcome new ideas and feature requests for Casper Bridge Smart Contracts. If you have a suggestion to improve the project, please follow these steps:
+
+1. Check the [existing issues](https://github.com/ferrumnet/bridge-casper-smart-contracts/issues) to see if your idea has already been discussed.
+2. If the idea is new, [open a new issue](https://github.com/ferrumnet/bridge-casper-smart-contracts/issues/new) and provide a clear and descriptive title and description.
+3. Clearly explain why the feature would be beneficial and any potential implementation details.
+
+## Pull Requests
+
+We appreciate any contributions through pull requests. To contribute code to Casper Bridge Smart Contracts, please follow these steps:
+
+1. Fork the repository and create a new branch from `main`.
+2. Make your changes, ensuring that your code follows the [style guidelines](#style-guidelines).
+3. Write appropriate tests to cover your changes, if applicable.
+4. Commit your changes and push the branch to your forked repository.
+5. Open a pull request from your branch to the `main` branch of this repository.
+6. Provide a clear title and description of the changes you made, as well as any relevant information for reviewers.
+
+## Style Guidelines
+
+To maintain consistency throughout the codebase, please adhere to the following style guidelines:
+
+- Follow the existing code formatting and naming conventions.
+- Write clear and concise code with appropriate comments when necessary.
+- Use descriptive variable and function names.
+- Ensure your code passes any existing tests.
+- If you add new functionality, consider adding relevant tests.
+
+## License
+
+By contributing to Casper Bridge Smart Contracts, you agree that your contributions will be licensed under the [MIT License]

README.md

@@ -74,10 +74,19 @@ sudo apt install clang
 ```
 
 ## Makefile Commands
-For generating the cargo documentation:
+For generating the cargo documentation: 
+Change directory into contract directory by running
+
 ```bash
-Cargo doc
-``` 
+ cd contract
+```
+
+then run :
+
+```bash
+cargo doc
+```
+
 Make commands:
 ```bash
 prepare:

SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.