contributing documentation

.vscode/settings.json

@@ -1,8 +1,10 @@
 {
 	"cSpell.words": [
+		"Alicio",
 		"Athen",
 		"athenlabs",
 		"preinstall",
+		"Sardinha",
 		"tailwindcss",
 		"Usehooks"
 	],

ARCHITECTURE.md

@@ -0,0 +1,3 @@
+# Architecture
+
+> Under development

AUTHORS.md

@@ -0,0 +1,7 @@
+# Authors
+
+Sorted in alphabetical order:
+
+- [Alicio Alves](https://github.com/alicioalves) - Partner Developer
+- [Augusto Sardinha](https://github.com/augustosardinha) - Partner Developer
+- [Gabriel Santos Cardoso](https://github.com/eng-gabrielscardoso) - Partner Developer

CODE_OF_CONDUCT.md

@@ -0,0 +1,56 @@
+# Code of Conduct
+
+## Introduction
+
+We, as contributors and maintainers of this project, are committed to creating a respectful and inclusive environment for everyone involved. We value the participation of individuals from different backgrounds and experiences and aim to foster a community that is welcoming and free from discrimination, harassment, and offensive behaviour.
+
+This code of conduct outlines our expectations for all project participants, including contributors, maintainers, and users. By participating in this project, you agree to abide by this code of conduct and to help create a positive and inclusive community.
+
+## Expected Behaviour
+
+All participants are expected to:
+
+- Be respectful and considerate towards others.
+- Use inclusive language and be mindful of the diversity of our community.
+- Accept constructive criticism and provide constructive feedback.
+- Be open-minded and receptive to different opinions and perspectives.
+- Be collaborative and supportive towards fellow contributors.
+- Report any unacceptable behaviour to the project maintainers.
+
+## Unacceptable Behaviour
+
+Unacceptable behaviour includes, but is not limited to:
+
+- Harassment, discrimination, or offensive comments related to personal attributes, including but not limited to race, ethnicity, gender, sexual orientation, religion, or disability.
+- Any form of intimidation, bullying, or personal attacks.
+- Inappropriate or unwelcome advances, messages, or attention.
+- Public or private harassment or trolling.
+- Publishing others' private information, such as physical or electronic addresses, without explicit permission.
+- Any other conduct that violates applicable laws, regulations, or common decency.
+
+## Consequences of Unacceptable Behaviour
+
+Participants who engage in unacceptable behaviour may face consequences, which can include:
+
+- Temporary or permanent bans from participation in the project.
+- Reporting to appropriate authorities or third parties, if necessary.
+- Removal of contributions, comments, or other content deemed inappropriate.
+- Any other actions deemed appropriate by the project maintainers.
+
+## Reporting Guidelines
+
+If you witness or experience any behaviour that violates this code of conduct, please report it to the project maintainers. You can do so by contacting the maintainers via email or private message.
+
+All reports will be kept confidential and will be reviewed and addressed promptly. Please provide as much detail and evidence as possible to help in the investigation process.
+
+## Acknowledgment
+
+This code of conduct is adapted from the Contributor Covenant (https://www.contributor-covenant.org/), version 2.0.
+
+## Scope
+
+This code of conduct applies to all project spaces, including project repositories, issue trackers, social media channels, mailing lists, and any other platforms or communication channels related to the project.
+
+## Conclusion
+
+We believe that by following this code of conduct, we can create a positive and inclusive environment that encourages collaboration, fosters respect, and allows the project to thrive. We appreciate your cooperation in making this project a welcoming and inclusive community.

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Welcome! We appreciate your interest in contributing to our project. This document provides guidelines and instruction on how to contribute effectively to our project.
+
+## Getting Started
+
+### Prerequisites
+
+- Knowledge about NodeJS, Javascript, Typescript, Jest and Test Orientation Development
+- Optionally but recommended, knowledge about Docker, Docker Composer and some experience with the stack.
+
+### Setup
+
+To setup your local repository just follow the instructions in the documentation [here](README.md).
+
+## Contributing Guidelines
+
+We welcome contributions from the community to make our project even better! Please follow the guidelines below to ensure a smooth contribution process.
+
+### Reporting Issues
+
+If you encounter any bugs, have suggestions, or want to request a new feature, please [submit an issue](https://github.com/athenlabs/athenlabs-landing-page/issues). When reporting an issue, please provide a detailed description and, if possible, steps to reproduce the problem.
+
+### Feature Requests
+
+We also appreciate well-thought-out feature requests. If you have an idea for an improvement or a new feature, please [submit an issue](https://github.com/athenlabs/athenlabs-landing-page/issues) to discuss it with the community.
+
+### Code Contribution
+
+To contribute with this project please follow the Git Flow standards, i.e., first clone the repository, make a branch, maintain the code style and the standards, test everything, and submit a pull request. You don't know about? Please read more [here](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).
+
+## Community
+
+We believe in fostering an open and inclusive community. We encourage respectful and constructive communication among contributors and maintainers. Please be considerate and understanding towards others.
+
+## Licence
+
+By contributing to this project, you are agreeing to that your contributions will be licenced under the [LICENCE](LICENSE.md) file of the project.

SECURITY.md

@@ -0,0 +1,15 @@
+# Security
+
+We deal with security very seriously. Pay attention to not upload any code that can lead to security issues to the application.
+
+Here are come important and most common security issues:
+
+- Do not include Docker images with reported security issues
+- Keep dependencies updated, newer versions can deal with discovered vulnerabilities.
+- Use the latest Node.JS version, specifically in this project newer versions of the runtime could better fit with performance than older versions
+- Avoid hardcoding sensitive information about environment variables that handle sensitive information as like API keys or credentials, database connections, etc
+- If you implement or find some input without validation please report, and if possible make the validation by yourself. This prevent common attacks like cross-site-scripting (XSS), etc
+- If you implement or find some input without sanitisation please report, and if possible make the sanitisation by yourself. This is prevent common attacks like SQL injection, etc
+- Prevent code injection attacks against some reported and discovered vulnerabilities in Javascript like the use of `eval()`. These practices can lead to code injection vulnerabilities.
+- Always maintain the project lint configuration and the code test coverage. Make sure to include to repository only code checked and tested.
+- Regularly update your deps, OS, and your environment as part of the security community. Your contribution is always welcome but do not break anything.