From e6309d807a8e02b294dab1e5bb60416d48795911 Mon Sep 17 00:00:00 2001 From: Zulekha Noor <60471866+millivio@users.noreply.github.com> Date: Wed, 13 Nov 2024 03:48:34 +0100 Subject: [PATCH 1/2] Update README.md ### Explanation of Changes - **Installation**: Provided step-by-step setup instructions. - **Changelog**: Linked to `CHANGELOG.md` for version updates. - **Contribution**: Linked to `CONTRIBUTING.md` for collaboration guidelines. - **Acknowledgments**: Section to credit contributors and supporters. This structure ensures the README is comprehensive and user-friendly. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index f1f2297426..30a555c1ef 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,22 @@ Start creating your standout resume with Reactive Resume today! - SMTP Server (to send password recovery emails) - GitHub/Google OAuth (for quickly authenticating users) - LinguiJS and Crowdin (for translation management and localization) + +## Installation + +To install and run Reactive Resume locally: + +Clone the repository: +git clone https://github.com/AmruthPillai/Reactive-Resume.git + +Change into the directory: +cd Reactive-Resume + +Install dependencies: +npm install + +Run the application: +npm start ## Star History @@ -85,10 +101,22 @@ Start creating your standout resume with Reactive Resume today! +## Contributing + +We welcome contributions! Please see the [Contributing Guidelines](/CONTRIBUTING.md) for details. + +## Changelog + +See the [CHANGELOG](/CHANGELOG.md) for details on recent updates and version history. + ## License Reactive Resume is packaged and distributed using the [MIT License](/LICENSE.md) which allows for commercial use, distribution, modification and private use provided that all copies of the software contain the same license and copyright. +## Acknowledgments + +Special thanks to the community and all contributors for their support and contributions. + _By the community, for the community._ A passion project by [Amruth Pillai](https://www.amruthpillai.com/) From e4d7b214cc17692ca73632886b5690befcb6b21e Mon Sep 17 00:00:00 2001 From: Zulekha Noor <60471866+millivio@users.noreply.github.com> Date: Wed, 13 Nov 2024 04:03:19 +0100 Subject: [PATCH 2/2] Created CODE_OF_CONDUCT.md code of conduct file is added. --- CODE_OF_CONDUCT.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..17ed83d038 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,39 @@ +# Contributor Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socioeconomic status, nationality, personal appearance, race, religion, or sexual identity and orientation. + +We pledge to act and interact in ways that contribute to an inclusive, welcoming, and supportive community. + +## Our Standards + +Examples of behavior that contributes to a positive environment include: + +- Using welcoming and inclusive language +- Respecting differing viewpoints and experiences +- Providing and receiving constructive feedback gracefully +- Accepting responsibility and apologizing when necessary +- Focusing on what is best for the community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery and unwelcome advances +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others’ private information, such as a physical or electronic address, without permission +- Any conduct that 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 action in response to any behavior that is deemed unacceptable. + +Maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned with this Code of Conduct. + +## Scope + +This Code of Conduct applies to all project spaces, including the repository, issue trackers, chat forums, and other communication channels. It also applies when an individual is representing the project or community in public spaces. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.1.