diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 052c854..ada540c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -The issue tracker is only for bug reports and enhancement suggestions. +The issue tracker is only for bug reports and enhancement suggestions. If you wish to contribute to the Lucia codebase or documentation, feel free to fork the repository and submit a pull request. We use Prettier to enforce a consistent coding style, so having that set up in your editor of choice @@ -14,3 +14,7 @@ To get ready to work on the codebase, please do the following: 2. Run `npm install` 3. Code your heart out! 4. [Submit a pull request](https://github.com/aidenybai/lucia/compare) (Make sure you follow the [conventional commit format](https://github.com/aidenybai/lucia/blob/master/.github/COMMIT_CONVENTION.md)) + +## Lucia Core + +Before contributing to Lucia's core, be sure to read this [markdown document](https://github.com/aidenybai/lucia/tree/master/src/core#readme). diff --git a/src/core/README.md b/src/core/README.md index 0ff9e8a..cb24519 100644 --- a/src/core/README.md +++ b/src/core/README.md @@ -35,7 +35,9 @@ The Lucia' core is designed to accomplish a balance between being **fast and com ## Overview - +