From cd13a94dd1b676b1911dadd7fdc4af1e3af94600 Mon Sep 17 00:00:00 2001 From: Kevin FEDYNA Date: Tue, 28 Jan 2025 22:35:42 +0100 Subject: [PATCH] Pushed contributing --- Contributing.md | 129 ++++++++++++++++++++++++++++++++++++++++++++++++ FAQs.md | 6 +-- Home.md | 6 +-- 3 files changed, 135 insertions(+), 6 deletions(-) diff --git a/Contributing.md b/Contributing.md index e69de29..320867d 100644 --- a/Contributing.md +++ b/Contributing.md @@ -0,0 +1,129 @@ +# Contributing to PolyMPR 🀝 + +Thank you for your interest in contributing to **PolyMPR**! Whether you're a developer, designer, or just someone with great ideas, your contributions are welcome and appreciated. This guide will walk you through the process of contributing to the project, from setting up your environment to submitting your changes. πŸš€ + +## How to Contribute πŸ› οΈ + +There are many ways to contribute to PolyMPR, including: + +- **Reporting bugs** πŸ› +- **Suggesting new features** πŸ’‘ +- **Improving documentation** πŸ“š +- **Writing code** πŸ’» +- **Helping others** in the community 🀝 + +## Getting Started πŸš€ + +### 1. **Set Up Your Development Environment** +Before you start contributing, you'll need to set up your development environment. Follow these steps: + +1Β². **Clone the Repository**: + - Clone your forked repository to your local machine: + ```bash + git clone https://github.com/fedyna-k/PolyMPR.git + cd PolyMPR + ``` + +3. **Install Dependencies**: + - Ensure you have **Deno** installed. If not, follow the [Deno installation guide](https://deno.land/#installation). + - Install project dependencies: + ```bash + deno task start + ``` + +4. **Set Up Docker (Optional)**: + - If you plan to use Docker, ensure it’s installed and running. Use the provided `docker-compose.yml` file to build and run the application: + ```bash + docker-compose up --build + ``` + +### 2. **Find an Issue or Suggest a New Feature** +- Browse the [Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues) to find open issues or feature requests. +- If you have a new idea, open a new issue to discuss it with the community before starting work. + +### 3. **Create a New Branch** +Before making changes, create a new branch for your work: +```bash +git checkout -b PMPR-:ISSUE_ID: +``` + +### 4. **Make Your Changes** +- Write your code, fix bugs, or improve documentation. +- Follow the [coding guidelines](#coding-guidelines) to ensure consistency. + +### 5. **Test Your Changes** +- Run the application locally to ensure your changes work as expected. +- Ensure all tests pass. + +### 6. **Commit Your Changes** +- Commit your changes with a clear and descriptive commit message: + ```bash + git commit -m "Add: New feature for user management" + ``` + +### 7. **Push Your Changes** +Push your changes to your forked repository: +```bash +git push origin feature/your-feature-name +``` + +### 8. **Submit a Pull Request (PR)** +1. Go to the [PolyMPR GitHub repository](https://github.com/fedyna-k/PolyMPR). +2. Click the "New Pull Request" button. +3. Select your branch and provide a detailed description of your changes. +4. Submit the PR and wait for feedback from the maintainers. + +## Coding Guidelines πŸ“œ + +To maintain consistency across the project, please follow these guidelines: + +### 1. **Code Style** +- Use **TypeScript** for all new code. +- Follow the Deno style guide for formatting. +- Use meaningful variable and function names. + +### 2. **Documentation** +- Update the documentation if your changes introduce new features or modify existing ones. +- Use clear and concise comments in your code. + +### 3. **Testing** +- Ensure all tests pass before submitting a PR. + +### 4. **Commit Messages** +- Use the following format for commit messages: + ``` + Type: Short description + ``` + - **Type**: `Add`, `Fix`, `Update`, `Refactor`, `Remove`, etc. + - **Description**: A brief summary of the changes. + +## Community Guidelines 🌟 + +We value a positive and inclusive community. Please follow these guidelines when contributing: + +1. **Be Respectful**: Treat everyone with kindness and respect. +2. **Be Open-Minded**: Welcome diverse perspectives and ideas. +3. **Be Collaborative**: Work together to improve the project. +4. **Be Constructive**: Provide helpful feedback and suggestions. + +## Recognition and Thanks πŸ™ + +We appreciate every contribution, no matter how small! Contributors will be recognized in the following ways: +- Your name will be added to the [Contributors List](#contributors-list). +- You’ll receive a shoutout in the release notes for significant contributions. + +## Contributors List 🌟 + +Thank you to all the amazing contributors who have helped make PolyMPR better! πŸŽ‰ + +- **Kevin FEDYNA** - Project initiator and architect. +- **Romain MUNOS** - Project initiator and main developer. + +## Next Steps πŸš€ + +Now that you know how to contribute, here are some resources to help you get started: +- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Find open issues to work on. +- **[Documentation](https://github.com/fedyna-k/PolyMPR/wiki)**: Learn more about PolyMPR’s architecture and features. +- **[Tutorials](/tutorials)**: Step-by-step guides for common tasks. + +Thank you for contributing to PolyMPR! Together, we can build a better future for HR management. Happy coding! πŸ’»βœ¨ \ No newline at end of file diff --git a/FAQs.md b/FAQs.md index 4606ad8..46afe77 100644 --- a/FAQs.md +++ b/FAQs.md @@ -25,7 +25,7 @@ Yes! PolyMPR is **open-source** and released under the **MIT License**. You can To install PolyMPR, clone the GitHub repository and follow the [installation guide](./installation). You’ll need **Deno** and optionally **Docker** for containerized deployments. ```bash -git clone https://github.com/PolyMPR/PolyMPR.git +git clone https://github.com/fedyna-k/PolyMPR.git cd PolyMPR deno task start ``` @@ -73,8 +73,8 @@ Make sure the application is running and there are no errors in the terminal. If ### 15. **Where can I get help if I’m stuck?** You can: -- Join the [GitHub Discussions](https://github.com/PolyMPR/discussions) to ask questions and share ideas. -- Report issues on the [Issue Tracker](https://github.com/PolyMPR/issues). +- Join the [GitHub Discussions](https://github.com/fedyna-k/PolyMPR/discussions) to ask questions and share ideas. +- Report issues on the [Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues). - Consult the [documentation](https://github.com/fedyna-k/PolyMPR/wiki) for detailed guides and tutorials. ### 16. **How can I contribute to PolyMPR?** diff --git a/Home.md b/Home.md index a214a1e..ac5bf6b 100644 --- a/Home.md +++ b/Home.md @@ -35,6 +35,6 @@ By leveraging Deno's secure runtime and Fresh's edge-ready web framework, PolyMP PolyMPR is more than just a framework, it's a community. Whether you're looking to contribute code, report issues, or share ideas, we welcome your participation. -- **[GitHub Repository](https://github.com/PolyMPR)**: Access the source code and contribute to the project. πŸ’» -- **[Discussions](https://github.com/PolyMPR/discussions)**: Engage with other users and developers. πŸ’¬ -- **[Issue Tracker](https://github.com/PolyMPR/issues)**: Report bugs or request new features. πŸ› \ No newline at end of file +- **[GitHub Repository](https://github.com/fedyna-k/PolyMPR)**: Access the source code and contribute to the project. πŸ’» +- **[Discussions](https://github.com/fedyna-k/PolyMPR/discussions)**: Engage with other users and developers. πŸ’¬ +- **[Issue Tracker](https://github.com/fedyna-k/PolyMPR/issues)**: Report bugs or request new features. πŸ› \ No newline at end of file