Contributing

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:

  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.
   • Install project dependencies:

     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:

     docker compose up --build

2. Find an Issue or Suggest a New Feature

• Browse the Issue Tracker 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:

git checkout -b PMPR-:ISSUE_ID:

4. Make Your Changes

• Write your code, fix bugs, or improve documentation.
• Follow the 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:

  git commit -m "Add: New feature for user management"

7. Push Your Changes

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Submit a Pull Request (PR)

1. Go to the PolyMPR GitHub repository.
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.
• 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: Find open issues to work on.
• Documentation: Learn more about PolyMPR’s architecture and features.
• 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! 💻✨