Skip to content
This repository has been archived by the owner on Jul 16, 2023. It is now read-only.

Latest commit

 

History

History
70 lines (45 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

70 lines (45 loc) · 2.56 KB

Welcome to Unsafe-4-Bit contributing guide

'Salute you for reading this contributing guide!

Any contribution you make will be reflected/committed to this repository, so be careful on what you're doing!

Read our Code of Conduct to keep our community approachable and respectable.


Contributing code

Before contributing

You must know this before contributing:

  • Your contribution might be rejected for considerable reason(s).
  • Your submitted code might be or will be ___ with or without you knowing.
    • removed within the bounds of the project
    • modified as needed or as necessary
    • moved within the bounds of the project
    • copied within the bounds of the project
  • You will be known as a contributor of this repository.
  • You might be called out to fix a bug created by your code if necessary.

What to do when writing the code

  • Make the code concise.
  • Make the code compact.
  • Make the code readable.
    • Don't make it too readable or else we won't be accepting it!
    • Also, don't make the code too unreadable or else we won't be accepting it as well!
  • Take a look at some of the files to know what I meant by that.
  • Never forget to test and compile the code first on your machine before such reckless moves!

What to do after writing the code

  • Check, test and compile your code into it's appropriate directory.
  • Commit your changes into your fork.
    • Use Gitmojis before your commit message to indicate what your commit is for.
  • Open up a PR.
    • Fill up the form!
  • Wait for me to accept your changes!

Issues

Creating a new issue

If you spotted a problem or would like to create a new issue, search if an issue already exists.

If a related issue doesn't exist, you can open a new issue using a relevant issue form.


Solve an issue

Scan through our existing issues to find one that interests you.

You can narrow down the search at will using filters.

If you find an issue to work on, you are welcome to fork this repository and open up a PR containing your fix.

Remember, fill up the forms to give us as much information as possible!