Skip to content
Community
Contribution Guide

How to Contribute

PRs Welcome (opens in a new tab) Open Source Love (opens in a new tab)

๐Ÿ’ช What can I contribute?

You can contribute to Kanaries RATH in any form that you would like to! For instance, you may:

  • Participation in the community, by answering questions on GitHub open issues and in our chat groups, helps us maintain a healthy and active community of users.
  • We welcome your proposals for new features, as well as reporting issues and bugs to Kanaries RATH.
  • Submit codes to Kanaries RATH.
  • Other contributions include suggestions for website improvements and documentation.
  • Become a Top Kanaries RATH Committer!

๐Ÿ“ The contribution workflow

Here's a step-by-step guide to contributing code to Kanaries RATH:

For the first-time committer to submit a pull request, join us on Discord (opens in a new tab) for assistance!

๐Ÿž How can I report an issue?

The open-source community values constructive questions. Before submitting an issue, make sure you have done your research:

  • Avaialble documentations and FAQ.
  • Open issues on our GitHub repo.
  • Existing Pull Requests.

Open an issue (opens in a new tab) on the GitHub page with a detailed description of the problem. The community will be happy to help!

๐Ÿ‘พ How to make a Pull Request

  1. Navigate to our GitHub page (opens in a new tab). Click on the Fork button at the top right corner.

  2. Clone your forked repo to work with it locally:

git clone https://github.com/github-username/Rath.git
# Clone your repo
git remote -v
# Check if the upstream repo has been configured.
git remote add upstream https://github.com/Kanaries/Rath.git
# If not, add the upstream remote manually.
cd Rath
  1. Create a branch
git fetch upstream
git checkout master
git rebase upstream/master
git push origin master
# Keep your local fork up to date.
git checkout -b branch-name
  1. Commit and push changes to GitHub
git status
# Check what codes your've changed.
git add
# Check what files you've added to the git branch.
git commit -m "Your remarks"
# Commit
git push origin branch-name
# Push your branch to the repo's remote name.
  1. Open a pull request on GitHub

Visit your repo's GitHub page. Click on the "Compare&pull request" button at the top of the page.

Don't forget to provide the necessary information for your Pull Request! You will be notified via email once the PR request has been approved.

๐Ÿฅ‡ Submit a blog post

We are looking for guest bloggers to contribute posts to our blog. We encourage active users, top committers, and experts in the field to create interesting and informative content. We are always on the lookout for high-quality submissions, so if you have a passion for writing and have something to say, we'd love to hear from you! forthebadge