RegionX is a project dedicated to developing components for the new Agile Coretime model. The goal of the project is to enable developer teams, researchers, and enthusiasts to start trading, tracking, and analyzing the product Polkadot offers - Coretime.
We warmly welcome contributions from the community and are thrilled that you're interested in participating in our project! To maintain the quality and consistency of our codebase, please follow these guidelines when contributing.
-
Fork the Repository: Start by forking the repository to your own GitHub account. This will be your private workspace for making changes.
-
Clone the Fork: Clone the forked repository to your local machine to start working on the changes.
-
Pick an Issue: Begin by selecting an issue to work on from one of our repositories. If you have a new idea or a bug fix that's not listed, feel free to open a new issue. Please ensure the issue is not assigned to someone else or marked as "in progress".
-
Create a Branch: Create a new branch in your forked repository for each issue you work on. Please use a descriptive branch name that reflects the issue.
-
Code: Write your code following the project's coding standards and best practices. Ensure your code is clean, well-documented, and tested.
-
Commit Your Changes: Once your changes are complete, commit them to your branch. Use clear and concise commit messages, ideally with the issue number for reference.
-
Pull Request: Push your changes to your fork and submit a pull request to the main repository. In the pull request description, reference the issue it resolves (e.g., "Resolves #123"). Describe your changes and any relevant details that might help reviewers understand your contribution.
-
Code Review: Wait for the code review by the maintainers. Be open to feedback and ready to make any necessary revisions.
- Ensure your code adheres to the project's style guide.
- Write unit tests for new features or bug fixes.
- Keep your commits small and focused; one feature or fix per commit.
- Do not include unrelated changes in your pull request.
- Update the project's documentation if you're introducing changes to the API or core functionality.
- Be respectful and considerate in your interactions with other contributors.
Your contributions are a vital part of our project's success. Thank you for your help in making our project better!
We highly welcome contributions
The main repositories of this organization are:
- RegionX - Marketplace and tooling for Coretime
- CoreHub - A central hub for users to manage their Polkadot and Kusama Coretime
- Coretime-Mock - Repository containing Coretime mock runtimes that are used for local testing and simulation
- Corespace-Weigher - Tool for tracking the weight consumption of Polkadot and Kusama parachains
- 📖 Wiki: https://regionx.gitbook.io/wiki/
- 🌐 Website: https://regionx.tech/
- 📃 Proposal: W3F Proposal