Firstly, thank you for taking the time to contribute! We welcome contributions from the community and are grateful for any help you can provide.
If you find a bug or have a feature request, please report it using the GitHub issue tracker.
When reporting an issue, please include:
- A clear and descriptive title.
- A detailed description of the problem or suggestion.
- Steps to reproduce the issue, if applicable.
- Any error messages or screenshots that may help diagnose the problem.
We follow the GitHub Flow for our development process. Here's how you can contribute your changes:
-
Fork the repository: Click the "Fork" button at the top right of the repo's page.
-
Clone your fork: Clone your forked repository to your local machine.
git clone https://github.com/IBAX-io/multikey.git
cd multikey- Create a branch: Create a new branch for your work.
git checkout -b my-feature-branch-
Make your changes: Make your changes in the new branch.
-
Test your changes: Ensure that all existing and new tests pass.
-
Commit your changes: Commit your changes with a clear and descriptive commit message.
git commit -m "Add new feature"- Push to your fork: Push your changes to your forked repository.
git push origin my-feature-branch- Open a Pull Request: Navigate to the original repository and open a pull request from your forked branch.
In your pull request, please include:
- A clear and descriptive title.
- A detailed description of the changes.
- Any relevant issues or feature requests that the changes address.
To maintain consistency in the codebase, please adhere to the following coding standards:
- Use ESLint for JavaScript code linting.
- Follow the Airbnb JavaScript Style Guide.
- Ensure your code is well-documented.
Before submitting your changes, please ensure that all tests pass. To run the tests, use the following command:
pnpm test