-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 89ab178
Showing
51 changed files
with
1,469 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributing | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change. | ||
|
||
Please note we have a code of conduct, kindly follow it in all your interactions with the project. | ||
|
||
## Pull Request Process | ||
|
||
Make sure to commit following the Conventional Commits Standards. Your commit message should follow the pattern: `<type>[optional scope]: <description>` | ||
|
||
`type` refers to : | ||
|
||
- **feat**: A new feature | ||
- **fix**: A bug fix | ||
- **refactor**: Code refactoring | ||
- **test**: Additions or modifications to test cases | ||
- **docs**: README, or anything related to documentation | ||
- **chore**: Regular code maintenance | ||
|
||
`scope` (optional) refers to the section of the codebase you're working on _(eg. api, frontend, backend)_ | ||
|
||
`description` : A short summary providing additional contextual information about the code changes. | ||
|
||
Read more about [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) | ||
|
||
- Ensure any install or build dependencies are removed before the end of the layer when doing a build. | ||
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters. | ||
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer. | ||
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. | ||
|
||
## Code of Conduct | ||
|
||
### Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. | ||
|
||
### Our Standards | ||
|
||
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 | ||
|
||
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 | ||
|
||
### Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be 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 [INSERT EMAIL ADDRESS]. 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. Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at <http://contributor-covenant.org/version/1/4>. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2023 MentorMeInTech | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# MentorMeInTech ✨ | ||
|
||
Codebase for the MentorMeInTech landing page. | ||
|
||
Figma: [Mentor Me In Tech (Landing Page)](https://www.figma.com/file/8K3Xa5T6VkDkN9GKoygDtm/Mentor-Me-In-Tech-(Landing-page)) | ||
|
||
## Tech Stack 🛠️ | ||
|
||
- HTML 🌐 | ||
- CSS 🎨 | ||
- JavaScript ⚙️ | ||
|
||
## Contributing 🤝 | ||
|
||
### Setup 🚀 | ||
|
||
1. Clone the repository 📂 | ||
2. Open `index.html` in your browser 🌐 | ||
|
||
### Workflow 📝 | ||
|
||
1. Create a new branch 🌿 | ||
2. Make your changes ✏️ | ||
3. Commit your changes 💾 | ||
4. Push your changes 🚀 | ||
5. Create a pull request 🔄 | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions. | ||
|
||
## | ||
|
||
### Setup (Fork) 🍴 | ||
|
||
1. Fork the repository 🍽️ | ||
2. Clone the forked repository 📂 | ||
3. Open `index.html` in your browser 🌐 | ||
|
||
### Workflow (Fork) 📝 | ||
|
||
1. Make your changes ✏️ | ||
2. Commit your changes 💾 | ||
3. Push your changes 🚀 | ||
4. Create a pull request 🔄 | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions. | ||
|
||
## |
Oops, something went wrong.