Skip to content

Latest commit

 

History

History
90 lines (56 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

90 lines (56 loc) · 2.96 KB
Raw

Contributing to jot

Thank you for your interest in contributing to jot. This file outlines the guidelines for bug reports, feature requests, and code contributions.

Reporting Bugs

If you encounter a bug, please open a new issue on GitHub. Please include a clear and detailed description of the bug, steps to reproduce it, and any relevant error messages or screenshots.

Requesting Features

If you have an idea for a new feature, please open a new issue on GitHub. Please include a clear and detailed description of the feature, how it would benefit the project, and any other relevant details.

Contributing Code

Before you begin:

  • Please ensure that you have been assigned to an issue or have discussed your planned work with me to avoid potential loss of work.

Set up your fork:

  • Fork the repository to your account.
  • Clone the forked repository to your local machine.
  • Build/compile the program:
$ cargo build
  • Run the program using the executable created in 'target/debug/' or, run it directly (Pass in commands and arguments after '--'):
$ cargo run -- *args*

Make your changes:

  • Create a new branch for your changes:
$ git checkout -b *my-branch*
  • Make your changes, then lint and format your code:
$ cargo clippy
$ cargo fmt
  • When you are satisfied with your changes, commit them (Please follow commit message guidelines when writing your commit messages):
git commit -m "add: *description*"

Open a pull request:

  • Push your changes to your forked repository:
$ git push origin *my-branch*
  • On GitHub, open a pull request with your commit(s).

Please include a clear and detailed description of your changes in the pull request. If your changes are related to an issue, please reference the issue number in the pull request title or description.

Commit Message Guidelines

These guidelines are to ensure a consistent commit history. Following them is highly appreciated!

Write your commits in the following structure:

$ git commit -m "action: description"

There are 4 possible actions:

  • add: When adding a feature or file to the project.
  • remove: When removing a feature or file from the project.
  • fix: When fixing a bug. Mention the issue tag in description.
  • update: When your changes don't quite fall in the other categories.

Try to keep your commit description concise. Add other relevant information in the commit body.

Contact

If you have any concerns about the project, feel free to open an issue or email me to get in touch. I should respond within 24 hours.

Thank you for taking the time to read these guidelines. I hope you enjoy contributing to jot!