Contributions are always welcome, but we do ask you follow some basic guidelines when contributing code.
Please make sure all PRs are made off the proper base so there are no merge conflicts. All PRs must build successfuly with our CI, and any non-building PRs will not be approved.
Commit messages need to be descriptive of what the commit changes. Commits should only be focused around changing a single thing (working on a single issiue).
In the event that the change is purely documentation and not modify the way the code works, append [skip ci] to the start of the commit message.
TODO
At any point if a change is made to the database objects, a new migration is needed. Every release will have its own migration, that should never be deleted. Deleting a release migration will cause loss of data. Every change to the databse is considered a breaking change.
To add a new migration for your changes, go to the Package Manager Console in Visual Studio. Type Add-Migration Dev-MyName-MigrationName where MyName is your name and MigrationName is the name of the migration. If at any point you need to revert this, type Remove-Migration. Never remove migrations labeled Release.
There should only be a single migration per release, so keep your commits to including at most one additional Dev migration. Any new changes should be removed with Remove-Migration and a new migration added. As this breaks the database when the app attempts to update it, make sure to Drop Cascade the Schema and create a new public schema whenever you remove and old migration and add a new migration.
The above steps will help keep migrations clean and in order while allowing us to properly add new items to the Database and remove the possibiliy of accidental data loss.
We follow the C# Coding Conventions with a few small differences.
We prefer this. It is not required, but do not remove any exsisting uses of it.
Code comments that span multiple lines of code use // ... more comment text ... to indicate that it is continuing between lines of code.
Ex:
// We get the random number ...
int rand = GetRandomNumber();
// ... then send it to the user.
await ctx.RespondAsync(rand.ToString());It is recommended to run the code cleanup profile 1 before subitting a PR or other code change. This profile by default only removes and sorts using statements.