Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 1.75 KB
Raw

Contributing

Workflow

  1. Fork and clone this repository.
  2. Create a new branch in your fork based off the main branch.
  3. Make your changes.
  4. Commit your changes, and push them.
  5. Submit a Pull Request here!

Contributing to the code

The issue tracker is only for issue reporting or proposals/suggestions. If you have a question, you can ask the team in our Discord Server.

To contribute to this repository, feel free to create a new fork of the repository and submit a pull request.

Commit Guidelines

SloshDB Project Concept Guidelines

There are a number of guidelines considered when reviewing Pull Requests to be merged. This is by no means an exhaustive list, but here are some things to consider before/while submitting your ideas.

  • Everything in SloshDB Project should be generally useful for the majority of users. Don't let that stop you if you've got a good concept though, as your idea still might be a great addition.
  • Everything should follow OOP paradigms and generally rely on behaviour over state where possible. This generally helps methods be predictable, keeps the codebase simple and understandable, reduces code duplication through abstraction, and leads to efficiency and therefore scalability.