Welcome to Open Oracle Origami! We appreciate your interest in contributing to our blockchain project focused on providing oracles. By contributing your skills, knowledge, and ideas, you can help us build a robust and reliable oracle solution for the blockchain ecosystem. The Open Oracle Origami source code is licensed under the MIT license. We value contributions of any size or type from anyone! The smallest of fixes can make the biggest difference. Please dive in. Feel free to ask questions and engage with our community.
We follow an agile development process. You can view our current priorities for development and track progress on our project management platform. If you encounter a bug or have a problem, the best action is to open an issue on our GitHub repository (please search for related closed issues first). The issue will be prioritized and tracked, and we'll keep you updated as it progresses.
If you're interested in helping with the development cycle, feel free to tackle open issues. We have designated some issues as good introductory tasks for new contributors. Reach out to us on our communication channels to coordinate and get started
To get started with Open Oracle Origami, please follow these steps:
- Fork the repository on GitHub.
- Clone your forked repository to your local development environment.
- Set up the necessary dependencies and tools as outlined in the project's documentation.
- Familiarize yourself with the project structure, code conventions, and existing features.
- Explore the open issues and project roadmap to identify areas where you can contribute.
We welcome contributions in various forms, including bug fixes, feature enhancements, documentation improvements, and testing. Here are some guidelines to help you contribute effectively:
If you encounter a bug, have a feature request, or have a suggestion for improvement, please submit an issue on the GitHub repository. Provide a clear and detailed description of the problem or enhancement you are addressing, along with any relevant information or steps to reproduce the issue.
To contribute code changes or feature implementations, please follow these steps:
- Create a new branch in your local repository, with a descriptive name that reflects the purpose of your changes.
- Make your code changes, adhering to the project's coding conventions and best practices.
- Write clear and concise commit messages, describing the purpose and scope of each commit.
- Test your changes to ensure they do not introduce new issues and are compatible with the existing codebase.
- Submit a pull request from your branch to the main repository, outlining the changes you've made and providing any additional context or information.
Our maintainers will review your pull request and provide feedback or suggestions. Once your changes meet the project's standards and requirements, they will be merged into the main repository.
Improvements to project documentation are highly valuable. If you identify areas where the documentation can be enhanced, please submit a pull request with the proposed changes. This includes updates to README files, inline code comments, or any other relevant documentation.
Testing is a core aspect of our development philosophy. We believe that well-tested code is crucial for building an application that powers the infrastructure of the future. If you have experience with testing frameworks or methodologies, contributions that enhance the project's test coverage are greatly appreciated. Submit pull requests with new test cases or improvements to existing tests.
When making changes to the code, please adhere to our style guide to maintain consistency and readability.
Open Oracle Origami follows a Code of Conduct to ensure a welcoming and inclusive community. We expect all contributors to adhere to this code when participating in any project activities or contributing to the open source code
By contributing to Open Oracle Origami, you agree that your contributions will be licensed under the project's LICENSE and that you have the necessary rights and permissions to make the contribution.
Thank you for your interest in contributing to Open Oracle Origami. Together, let's shape the future of blockchain oracles!
More information and resources will be provided in the future. We appreciate your interest and look forward to your contributions to Open Oracle Origami!