diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7fe6ffe..e20cc8f 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -6,3 +6,6 @@ contact_links: - name: Feature Request url: https://github.com/edge-js/edge/issues/new?title=Discussion%20for%20a%20new%20feature%20-%20%3CYOUR%20FEATURE%20NAME%3E about: Suggest any ideas you have by creating a new issue + - name: Documentation issue + url: https://github.com/edge-js/edgejs.dev/issues/new + about: For documentation issues, suggest changes on our documentation repository. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8d58ebd..9e6f6ca 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ ### 🔗 Linked issue diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 0d9c5fb..d4e72bb 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -26,6 +26,8 @@ If you're reporting a bug, include as much information as possible with the code ## Having a discussion You often want to discuss a topic or maybe share some ideas. In that case, create an issue and prefix it with the **Idea** keyword. For example: `Idea - Should we add support for X`. + + ## Creating pull requests It is never a good experience to have your pull request declined after investing a lot of time and effort in writing the code. Therefore, we highly recommend you to [kick off a discussion](https://github.com/edge-js/edge/issues/new?title=Discussion%20for%20a%20new%20feature%20-%20%3CYOUR%20FEATURE%20NAME%3E) before starting any new work on your side. @@ -67,7 +69,7 @@ Following is the list of tools in use. | TS Node | We use [ts-node](https://typestrong.org/ts-node/) to run tests or scripts without compiling TypeScript. The main goal of ts-node is to have a faster feedback loop during development | | SWC | [SWC](https://swc.rs/) is a Rust based TypeScript compiler. TS Node ships with first-class support for using SWC over the TypeScript official compiler. The main reason for using SWC is the speed gain. | | NP | We use [np](https://github.com/sindresorhus/np) to publish our packages on npm. Np does all the heavy lifting of creating a release and publishes it on npm and Github. The np config is defined within the `package.json` file. | -| ESLint | ESLint helps us enforce a consistent coding style across all the repos with multiple contributors. All our ESLint rules are published under the [eslint-plugin-adonis](https://github.com/adonisjs-community/eslint-plugin-adonis) package. | +| ESLint | ESLint helps us enforce a consistent coding style across all the repos with multiple contributors. All our ESLint rules are published under the [@adonisjs/eslint-config](https://github.com/adonisjs/tooling-config/tree/main/packages/eslint-config) preset. | | Prettier | We use prettier to format the codebase for consistent visual output. If you are confused about why we are using ESLint and Prettier both, then please read [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html) doc on the Prettier website. | | EditorConfig | The `.editorconfig` file in the root of every project configures your Code editor to use a set of rules for indentation and whitespace management. Again, Prettier is used for post formatting your code, and Editorconfig is used to configure the editor in advance. | | Conventional Changelog | All of the commits across all the repos uses [commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint) to enforce consistent commit messages. | diff --git a/docs/SECURITY.md b/docs/SECURITY.md index 63d50c1..73b3fd7 100644 --- a/docs/SECURITY.md +++ b/docs/SECURITY.md @@ -1,3 +1,3 @@ # Security Policy -If you discover a security vulnerability within VineJS, please send an email to Harminder Virk at virk@adonisjs.com. All security vulnerabilities will be promptly addressed. +If you discover a security vulnerability within Edge, please send an email to Harminder Virk at virk@adonisjs.com. All security vulnerabilities will be promptly addressed.