-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 parent
77ed77d
commit 84ced72
Showing
3 changed files
with
289 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,76 @@ | ||
# Contributor Covenant 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, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, 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 smaranjitghose@protonmail.com. 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][homepage], version 1.4, | ||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see | ||
https://www.contributor-covenant.org/faq |
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,192 @@ | ||
# Contribution Guidelines [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/smaranjitghose/awesome-portfolio-websites/issues): | ||
|
||
|
||
<p align="center"><img src="./readme_assets/Contribute.png" width=600></p> | ||
|
||
We want to make contributing to this project as easy and as transparent as possible, whether it's:<br> | ||
|
||
- Reporting a bug :bug: | ||
|
||
- Submitting a fix :mag_right: | ||
|
||
- Proposing new features :bulb: | ||
|
||
If you wish to contribute to this project, please raise an issue and wait for the project maintainers to approve it or give feedback before making a change. | ||
|
||
This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. | ||
|
||
## Code of Conduct | ||
|
||
Make sure to read it here: [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) | ||
|
||
|
||
## Preliminaries | ||
|
||
- Download and install the latest stable version of [Git](https://git-scm.com/downloads) 📥 for version control | ||
- Create a [Github](https://github.com/join) Account 📇 | ||
- Download and install latest stable version of [VS Code](https://code.visualstudio.com/download) | ||
|
||
## A. Setting up the Project | ||
|
||
**1.** Fork [this](https://github.com/smaranjitghose/awesome-portfolio-websites) repository. | ||
|
||
<p align="center"><img src="readme_assets\Fork_Repo.gif" width="500" height="200" /></p> | ||
|
||
|
||
**2.** Clone your forked copy of the project. | ||
|
||
``` | ||
git clone --depth 1 https://github.com/<your_user_name>/awesome-portfolio-websites.git | ||
``` | ||
<p align="center"><img width=35% src="readme_assets\clone_repo.gif" width="500" height="200" /></p> | ||
|
||
**3.** Navigate to the project directory :file_folder: . | ||
|
||
``` | ||
cd awesome-portfolio-websites | ||
``` | ||
|
||
**4.** Add a reference to the original repository. | ||
|
||
``` | ||
git remote add upstream https://github.com/smaranjitghose/awesome-portfolio-websites.git | ||
``` | ||
|
||
**5.** Check the remotes for this repository. | ||
|
||
``` | ||
git remote -v | ||
``` | ||
|
||
**6.** Always take a pull from the upstream repository to your master branch to keep it at par with the main project(updated repository). | ||
|
||
``` | ||
git pull upstream master | ||
``` | ||
|
||
- Comment on any existing [issue(s)](https://github.com/smaranjitghose/awesome-portfolio-websites/issues) raised by **project maintainers**. Otherwise raise a [new issue](https://github.com/smaranjitghose/awesome-portfolio-websites/issues/new). | ||
|
||
> ### Guidelines for raising a new issue: | ||
> | ||
> - Each issue should have an appropriate and short title like "Bug in Experience Page" | ||
> | ||
> - Whenever a participant raises an issue, by default it would be assigned to that participant due to obvious reasons. | ||
> | ||
> - Be specific about your intended changes/suggestions | ||
> | ||
> - Refrain from using phrases like "Hi, I am ..", "Please assign me this issue", "Thank You..", etc. We are only interested in technical parts | ||
> | ||
> - Attach a screenshot/clip if applicable | ||
> | ||
> - Please be patient enough. The project maintainers/mentors would review it as per their schedule. Refrain from putting up comments like "Please check this" ,"Please review this PR" etc. | ||
> | ||
>- An issue would be assigned to a participant for a minimum of 1 day and a maximum of 3 days. If the tenure of a particular participant is not over please do not spam the issue thread by writing, " I am interested" etc. You are welcome to do so if the participant has not met the requirements with around 12 hours remaining for their deadline. | ||
> | ||
> - Feel free to suggest your opinions on the already raised issues. | ||
> | ||
> - All participants are welcomed to suggest new features/bug fixes/improvements and raise new issues for those. However, the assignment would be done once approved by either of the project maintainers or the mentors. | ||
> | ||
> - Do not blindly comment on issues raised by other participant(s). Unless a minimum of 48 hours has passed since their assignment, the issue would not be re-assigned(excluding certain cases). The issue raised by a participant will always to be assigned to him/her by default. Do not spam "Interested", "Please assign me" in others issues. | ||
> | ||
> - Always keep a note of the deadline. | ||
## B. Contributing to the Project | ||
|
||
- Once the project maintainer(s)/mentor(s) have reviewed the issue/assigned you the issue. Start working on the changes. | ||
|
||
**1.** Create a new branch (DO NOT name it MAIN or MASTER or anything random). | ||
|
||
``` | ||
git checkout -b <your_branch_name> | ||
``` | ||
|
||
**2.** Perfom your desired changes to the code base. | ||
- Make sure that you do not change any code unrelated to the task that you have been assigned | ||
|
||
- Ensure that your changes apply to all screensizes | ||
|
||
- Comment any new code addition(s) | ||
|
||
- Do not mess up the directory structure | ||
|
||
- Preview your changes and test them properly before proceding ahead | ||
|
||
<p align="center"><img width=35% src="https://media2.giphy.com/media/L1R1tvI9svkIWwpVYr/giphy.gif?cid=ecf05e47pzi2rpig0vc8pjusra8hiai1b91zgiywvbubu9vu&rid=giphy.gif"></p> | ||
|
||
- Make a small clip or take screenshots before and after making changes. | ||
|
||
|
||
**3.** Track your changes:heavy_check_mark: | ||
|
||
``` | ||
git add . | ||
``` | ||
|
||
**4.** Commit your changes . | ||
|
||
``` | ||
git commit -m "Relevant message" (usually title of the pull request) | ||
``` | ||
- **Make sure to condense your changes into a single commit**. | ||
|
||
**5.** Push the committed changes in your feature branch to your remote repo. | ||
|
||
``` | ||
git push -u origin <your_branch_name> | ||
``` | ||
|
||
**6.** To create a pull request, click on `compare and pull requests`. Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to. | ||
|
||
<img src="./readme_assets/ComparePR.png" width=600> | ||
|
||
**7.** Then add an appropriate title and description to your pull request that explains your changes and efforts done. | ||
|
||
|
||
**8.** Click on `Create Pull Request`. | ||
|
||
<img src="./readme_assets/CreatePR.png" width=600> | ||
|
||
> ### Guidelines for raising a pull request: | ||
> | ||
> - Each pull request should have an appropriate and short title like "Fixed Bug in Experience Page" | ||
> | ||
> - In case of multiple commits, please perform a rebase and make a squash commit before giving the pull request. | ||
> | ||
> - Pull Requests without a description would often not be reviewed. Make sure you describe your intended changes in the description section of the pull request. (Use bullet points and phrases) | ||
> | ||
> - Make sure to refer the respective issue in the respective PR using phrases like `Resolves #issue_number` or `Closes #issue_number`. Here's an example to raise a PR: | ||
``` | ||
Fixes #640 | ||
# Work Done: | ||
- Fixed Responsiveness bug in the MOOC Section of the Education Page | ||
- Made the Favicon more optimized | ||
- ... | ||
- ... | ||
- ... | ||
# Relevant Screenshots/Gifs | ||
``` | ||
|
||
> - Refrain from using phrases like "Hi, I am ..", "Please merge me this PR", "Thank You..", etc. We are only interested in technical parts. | ||
> | ||
> - Attach a screenshot/clip of the change(s). | ||
> | ||
> - Please be patient enough. The project maintainers/mentors would review it as per their schedule. Please do not start putting comments like "Please check this" etc. | ||
> | ||
> - Not every PR would be merged directly. In majority of the scenarios, we would be offering some additional suggestions which are to be incorporated in the same PR with a squash commit. | ||
> | ||
> - Look out for possible merge conflicts. Please add comments required, this makes your code readable. | ||
> | ||
>- Make sensible variable names. For example, card1 is quite ambiguous but education_card implies what that variable is declared for. | ||
> | ||
> - Although we support feedback from everyone in all phases of development, it is highly advised not to put any negative comments in other participant's pull requests. | ||
> | ||
> - Always keep a note of the deadline. | ||
|
||
**9.** Voila :exclamation: You have made a PR to the awesome-developer-portfolio project :boom: . Sit back patiently and relax while the project maintainers review your PR. Please understand at times the time can vary from a few hours to a few days. | ||
|
||
<p align="center"><img src="https://media.giphy.com/media/5mCQOcUfywmyI/giphy.gif" width=35%></p> | ||
|
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) 2020 Smaranjit Ghose, Anush Bhatia | ||
|
||
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. |