Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (40 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

59 lines (40 loc) · 2.57 KB

contributing to auth's RNG

thank you for your interest in contributing to auth's RNG! please follow these guidelines to ensure smooth collaboration!!!!!!!!!!!!!!!

how to contribute

  1. fork the repository
    click the "fork" button on the top-right of the repo page to create your own copy.

  2. clone your fork
    once you've forked the repo, clone it to your local machine:
    git clone https://github.com/your-username/auths-RNG.git

  3. create a branch
    create a new branch for your work:
    git checkout -b feature/your-feature-name

  4. make changes
    work on the feature, fix, or improvement you want to contribute.

  5. commit your changes
    commit your changes with a clear and concise message:
    git commit -m "add feature: description of the change"

  6. push to your fork
    push your changes to your forked repo:
    git push origin feature/your-feature-name

  7. create a pull request
    open a pull request (PR) from your fork's branch to the main repository. describe the changes you've made and why!

pull request guidelines

  • describe your changes clearly. provide context on what was changed and why.
  • test your changes before submitting a PR. ensure that the game still works and that your code does not introduce bugs.
  • keep commits focused on one task or feature. if necessary, break down large changes into smaller, manageable pieces.
  • maintain coding style. follow existing coding conventions, such as indentation, variable naming, and comments.
  • avoid modifying unrelated files. only modify files related to the feature or bug fix you're working on.
  • keep it simple. don't overcomplicate your changes. aim for clean, understandable code.
  • and the most important.. NEVER TOUCH THE .github/workflows FOLDERS AND FILES! please... im begging you...

issue tracker

if you find a bug or have a feature request, feel free to open an issue. please be clear about the problem you're encountering or the feature you'd like to see added.

code of conduct

  • be respectful to others. we all have different experiences, and it's important to be kind and understanding.
  • no spam or offensive content. keep all communication professional and on-topic.
  • be constructive when giving feedback. offer suggestions and alternatives when necessary.
  • be a normal human being and have common sense.

license

by contributing to this project, you agree that your contributions will be licensed under the same license as the project. see the LICENSE file for more details.

p.s.

don't use AI thanks