Welcome to Issuer Node! We're thrilled to have you here. Before you get started, please take a moment to review the following guidelines.
- How to Contribute
- Getting Started
- Issue Tracker Guidelines
- Code Contribution Guidelines
- Testing Guidelines
- Documentation
- License Information
- Contact Information
Reporting Issues: If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. If the bug is a security vulnerability, please report it directly in our Telegram channel.
Requesting Features: If you have ideas for new features or enhancements, please submit a feature request on GitHub.
Submitting Changes: Fork the repository, make your changes, and submit a pull request. The develop branch is the default branch for development. Pull request to main branch only will be accepted for hot-fixes or releases. Please follow the guidelines outlined below.
To set up the project locally, follow the README instructions.
For an advanced setup, visit our extended documentation.
Search for existing issues before creating new ones.
Provide detailed information and steps to reproduce when reporting bugs.
Follow the issue template if available.
Before submitting a contribution, please consider whether it will be useful to the community and try to minimize breaking changes. In general, a Pull Request with breaking changes is unlikely to be accepted immediately. Submit concise and focused pull requests with clear descriptions.
Follow the conventional commits specification both for the commits and PR names.
Use develop as the base and target branch for pull requests. Develop is our base branch for development. We create feature branches from develop and merge them back into develop when the feature is complete. From time to time we integrate the develop branch into main.
Be responsive to feedback and address any review comments promptly.
Write tests for new features or changes
Ensure all existing tests pass and the linter reports no errors before submitting your changes.
Run tests and linter locally with:
make up-test // To start the database used by tests
make tests // run all tests
make lint // run linterKeep documentation up-to-date with any changes or additions. Help improve existing documentation or contribute new documentation as needed.
By contributing to this project, you agree to the terms of licenses Apache and Mit.
If you have any questions or need assistance, feel free to contact the project maintainers in our Telegram channel.