Skip to content

Files

Latest commit

 

History

History
68 lines (35 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

68 lines (35 loc) · 3.63 KB

Contributing Guidelines

Thank you for considering contributing to Resubase! We appreciate your interest in making our platform better. Before you start contributing, please take a moment to read and follow these guidelines to ensure a smooth collaboration process.

Code of Conduct

Resubase follows an inclusive and welcoming environment for all contributors and users. We expect everyone to adhere to our Code of Conduct when participating in any project-related activities.

Ways to Contribute

There are several ways you can contribute to Resubase:

  1. Bug Reports: If you encounter any bugs or issues while using Resubase, please submit a detailed bug report.

  2. Feature Requests: If you have ideas for new features or improvements, feel free to submit a feature request.

  3. Documentation: Help improve the documentation by fixing errors, adding examples, or suggesting clarifications.

  4. Code Contributions: You can contribute code by fixing bugs, implementing new features, or improving existing ones.

  5. Reviewing Pull Requests: Review and provide constructive feedback on open Pull Requests.

Contribution Rules

To ensure a smooth and productive contribution process, please adhere to the following rules:

  1. Read the Documentation: Before contributing, make sure to read the existing documentation to understand the project's architecture, coding guidelines, and overall structure.

  2. Use Descriptive Commit Messages: Provide clear and descriptive commit messages for each change you make. It helps other contributors understand your changes easily.

  3. Create Separate Branches: For each contribution, create a separate branch with a meaningful name that reflects the changes you intend to make.

  4. Pull Request Guidelines: When submitting a Pull Request, make sure it includes only one feature or bug fix per request. If you are working on multiple changes, create separate Pull Requests for each of them.

  5. Testing: Ensure that your changes are thoroughly tested. Write unit tests whenever applicable and make sure all existing tests pass.

  6. Be Respectful: Be respectful and considerate when interacting with other contributors. Any form of harassment, discrimination, or offensive behavior will not be tolerated.

  7. Keep Codebase Clean: Follow the coding style and guidelines used in the project. Ensure proper indentation, formatting, and naming conventions.

  8. Avoid Dependency Bloat: Minimize adding unnecessary dependencies. Discuss with the community before introducing new dependencies.

  9. License Compatibility: Make sure your contributions are compatible with the project's MIT License. Any code you contribute will be subject to this license.

  10. Ask for Help: If you are unsure about anything, don't hesitate to ask for help or guidance from the community.

Getting Started

Ready to contribute? Here's how to get started:

  1. Fork the Resubase repository.

  2. Create a new branch for your contribution.

  3. Make your changes, following the guidelines mentioned above.

  4. Test your changes thoroughly.

  5. Submit a Pull Request to the main repository with a clear description of your changes.

  6. Our team will review your Pull Request, provide feedback, and work with you to get it merged.

Thank you for your valuable contributions! Together, let's make Resubase an even better platform for developers around the world.

If you have any questions or need assistance, feel free to reach out to us through issues or discussions.

Happy coding! 😊