Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

66 lines (46 loc) · 3.06 KB
Raw

Contributing

Issues & Bug Reports

Simply go to the issues tab and pick an according issue template. If there's nothing that matches your issue, use the custom template. Please, make sure you detail and reason all of your suggestions. Attach any media like image and video proof to help us understand what is wrong. For any security issues, please report them privately or open a vulnerability issue on GitHub. We will check it out ASAP. Make sure you follow the security guide.

Request for changes & Pull Requests

You first need to create a fork of the repository to commit your changes to it. Methods to fork a repository can be found in the GitHub Documentation.

Then add your fork as a local project:

git clone https://github.com/Hebei-Studios/Tang-County-Issues

Which remote URL should be used ?

Then, go to your local folder

cd Tang-County-Issues

Add git remote controls :

git remote add fork https://github.com/YOUR-USERNAME/Tang-County-Issues
git remote add upstream https://github.com/YOUR-USERNAME/Tang-County-Issues

You can now verify that you have your two git remotes:

git remote -v

Receive remote updates

In view of staying up to date with the central repository:

git pull upstream main

Choose a base branch

Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main. When creating a new branch, name it with useful information. For example, if your pull request fixes a bug, name it bugfix-20. This way it is clear that this branch fixes issue #20 which is a bug.

# Switch to the desired branch
git switch main

# Pull down any upstream changes
git pull

# Create a new branch to work on
git switch --create 1234-name-issue

Commit your changes, then push the branch to your fork with git push -u fork and open a pull request on the repository following the template provided.

While not always enforced, it is recommended to follow the code style guide provided. As this is only an issue tracker, we can only suggest you what to use if you plan to contribute to the project itself. The codebase follows the official Roblox Lua style guide and the Lua Rocks style guide. We use the default and recommended 4 tab spaces for indentation. All of that is up to your own preference and has no real meaning. You can read both of them here:
https://roblox.github.io/lua-style-guide/
https://github.com/luarocks/lua-style-guide

You can also check out all other files in the repository. They are upstreamed from our private codebase. We do this to encourage developers to join our small game development team. ;)
All private information stays private. What we show here is only the base of config files or dependencies.