diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 343188f..a47804e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -26,8 +26,6 @@ jobs: with: node-version: ${{ matrix.node-version }} - - run: ls -a - - name: Install dependencies run: npm i diff --git a/.vscode/settings.json b/.vscode/settings.json index fa62ff9..6eb7d6d 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -11,16 +11,14 @@ "explorer.confirmDragAndDrop": false, "editor.suggestSelection": "first", "editor.fontLigatures": true, - "extensions.showRecommendationsOnlyOnDemand": true, "explorer.openEditors.visible": 0, "explorer.confirmDelete": false, "editor.formatOnSave": true, "prettier.trailingComma": "es5", "prettier.printWidth": 160, "git.confirmSync": false, - "terminal.integrated.shell.windows": "C:\\Windows\\System32\\cmd.exe", "window.zoomLevel": 0, "vsicons.projectDetection.autoReload": true, "workbench.colorCustomizations": {}, - "conventionalCommits.scopes": ["config", "settings", "actions"] -} \ No newline at end of file + "conventionalCommits.scopes": ["config", "settings", "actions", "assets", "router"] +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 05fe896..cdcd8ae 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation. Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or + advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic + address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting ## Our Responsibilities @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at mayajsframework@gmail.com. All +reported by contacting the project team at info@mayajs.io. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index e4c2b28..2c17fa6 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -2,22 +2,22 @@ As a collaborator you will be involved with mayajs with some administrative responsibilities. This guide will help you understand your role and the responsibilities that come with being a collaborator. -1. __Adhere to and help enforce the Code of Conduct.__ It is expected that you have read the [code of conduct](https://github.com/mayajs/maya/blob/master/CODE_OF_CONDUCT.md) and that you agree to live by it. This community should be friendly and welcoming. +1. **Adhere to and help enforce the Code of Conduct.** It is expected that you have read the [code of conduct](https://github.com/mayajs/maya/blob/main/CODE_OF_CONDUCT.md) and that you agree to live by it. This community should be friendly and welcoming. -1. __Triage issues.__ As a collaborator you may help sort through the issues that are reported. Issues vary from bugs, regressions, feature requests, questions, etc. Apply the appropriate label(s) and respond as needed. If it is a legitimate request please address it, otherwise feel free to close the issue and include a comment with a suggestion on where to find support. If an issue has been inactive for more than a week (i.e, the owner of the issue hasn’t responded to you), close the issue with a note indicating stales issues are closed; it can always be reopened if needed. In the case of issues that require a code change encourage the owner to submit a PR. For less complex code changes, add a very simple and detailed checklist, apply the “first-timers-only” label, and encourage a newcomer to open source to get involved. +1. **Triage issues.** As a collaborator you may help sort through the issues that are reported. Issues vary from bugs, regressions, feature requests, questions, etc. Apply the appropriate label(s) and respond as needed. If it is a legitimate request please address it, otherwise feel free to close the issue and include a comment with a suggestion on where to find support. If an issue has been inactive for more than a week (i.e, the owner of the issue hasn’t responded to you), close the issue with a note indicating stales issues are closed; it can always be reopened if needed. In the case of issues that require a code change encourage the owner to submit a PR. For less complex code changes, add a very simple and detailed checklist, apply the “first-timers-only” label, and encourage a newcomer to open source to get involved. -1. __Answer questions.__ It is not expected that you provide answers to questions that aren’t relevant, nor do you need to mentor people on how to use JavaScript, etc. If the question is not directly about the module, please close the issue. If the question stems from poor documentation, please update the docs and consider adding a code example. In any event try to be helpful and remember that there’s no such thing as a stupid question. +1. **Answer questions.** It is not expected that you provide answers to questions that aren’t relevant, nor do you need to mentor people on how to use JavaScript, etc. If the question is not directly about the module, please close the issue. If the question stems from poor documentation, please update the docs and consider adding a code example. In any event try to be helpful and remember that there’s no such thing as a stupid question. -1. __Assist with PRs.__ By encouraging contributors to supply a PR for their own issue this is ideally where most of your attention will be focused. Keep a few things in mind as you review PRs. - - When fixing a bug: does the PR adequately solve the problem without introducing any regressions? - - When implementing a feature: does the feature fit within the scope of mayajs? - - When removing functionality: is it properly deprecated with a warning? - - When introducing functionality: is the API predictable? - - Does the new code work for all supported platforms/browsers? - - Do the tests and linting pass CI? - - Are there tests to validate the changes that have been made? +1. **Assist with PRs.** By encouraging contributors to supply a PR for their own issue this is ideally where most of your attention will be focused. Keep a few things in mind as you review PRs. -1. __Fix bugs and implement features.__ When things need to be fixed or implemented and a PR can’t wait, you may do things yourself. You should still submit a PR yourself and get it checked off by at least one other contributor. Keep the points from number 4 in consideration as you push your code. + - When fixing a bug: does the PR adequately solve the problem without introducing any regressions? + - When implementing a feature: does the feature fit within the scope of mayajs? + - When removing functionality: is it properly deprecated with a warning? + - When introducing functionality: is the API predictable? + - Does the new code work for all supported platforms/browsers? + - Do the tests and linting pass CI? + - Are there tests to validate the changes that have been made? -Thank you again for your help as a collaborator and in making mayajs community great! If you have any questions, or need any assistance please feel free to contact another collaborator or the owner. +1. **Fix bugs and implement features.** When things need to be fixed or implemented and a PR can’t wait, you may do things yourself. You should still submit a PR yourself and get it checked off by at least one other contributor. Keep the points from number 4 in consideration as you push your code. +Thank you again for your help as a collaborator and in making mayajs community great! If you have any questions, or need any assistance please feel free to contact another collaborator or the owner. diff --git a/COMMUNITY_GUIDELINES.md b/COMMUNITY_GUIDELINES.md index 1191371..2a0ba69 100644 --- a/COMMUNITY_GUIDELINES.md +++ b/COMMUNITY_GUIDELINES.md @@ -48,7 +48,7 @@ We are committed to maintaining a community where users are free to express them - **Impersonation** - You may not seek to mislead others as to your identity by copying another person's avatar, posting content under their email address, using a similar username or otherwise posing as someone else. Impersonation is a form of harassment. -- **Doxxing and invasion of privacy** - Don't post other people's personal information, such as phone numbers, private email addresses, physical addresses, credit card numbers, Social Security/National Identity numbers, or passwords. Depending on the context, such as in the case of intimidation or harassment, we may consider other information, such as photos or videos that were taken or distributed without the subject's consent, to be an invasion of privacy, especially when such material presents a safety risk to the subject. +- **Doxing and invasion of privacy** - Don't post other people's personal information, such as phone numbers, private email addresses, physical addresses, credit card numbers, Social Security/National Identity numbers, or passwords. Depending on the context, such as in the case of intimidation or harassment, we may consider other information, such as photos or videos that were taken or distributed without the subject's consent, to be an invasion of privacy, especially when such material presents a safety risk to the subject. - **Sexually obscene content** - Don’t post content that is pornographic. This does not mean that all nudity, or all code and content related to sexuality, is prohibited. We recognize that sexuality is a part of life and non-pornographic sexual content may be a part of your project, or may be presented for educational or artistic purposes. We do not allow obscene sexual content or content that may involve the exploitation or sexualization of minors. diff --git a/README.md b/README.md index 359280e..d2db90e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -

+

A simple Node.js framework for creating fast and scalable server-side applications.

Version @@ -50,11 +50,11 @@ To check out [live examples](https://github.com/mayajs/sample) and docs, visit [ ## Collaborating -See collaborating guides [here.](https://github.com/mayajs/maya/blob/master/COLLABORATOR_GUIDE.md) +See collaborating guides [here.](https://github.com/mayajs/maya/blob/main/COLLABORATOR_GUIDE.md) ## People -Author and maintainer [Mac Ignacio](https://github.com/macign) +Author and maintainer [Mac Ignacio](https://github.com/mackignacio) ## License diff --git a/maya.svg b/logo.svg similarity index 100% rename from maya.svg rename to logo.svg diff --git a/package-lock.json b/package-lock.json index afc929f..50899fb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1245,6 +1245,15 @@ "@jridgewell/sourcemap-codec": "^1.4.10" } }, + "@mayajs/router": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/@mayajs/router/-/router-0.7.4.tgz", + "integrity": "sha512-2mqJgN03GdMEfSmwbhLhL16GkxW5hxNqCbgNe0U9xU/I1RLd/Budn7kWyEeXLKhCZtTRxptHUUmxv3s1pntyTg==", + "dev": true, + "requires": { + "ws": "^8.6.0" + } + }, "@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", @@ -8203,6 +8212,12 @@ "signal-exit": "^3.0.7" } }, + "ws": { + "version": "8.6.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.6.0.tgz", + "integrity": "sha512-AzmM3aH3gk0aX7/rZLYvjdvZooofDu3fFOzGqcSnQ1tOcTWwhM/o+q++E8mAyVVIyUdajrkzWUGftaVSDLn1bw==", + "dev": true + }, "xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", diff --git a/package.json b/package.json index 4d4fb18..d226e80 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "trailingComma": "es5" }, "devDependencies": { - "@mayajs/router": "^0.6.6", + "@mayajs/router": "^0.7.4", "@types/jest": "^25.1.4", "@types/jsonwebtoken": "^8.5.6", "jest": "^28.0.3",