Skip to content

Latest commit

 

History

History
46 lines (38 loc) · 2.39 KB

CONTRIBUTION.md

File metadata and controls

46 lines (38 loc) · 2.39 KB
Raw

Contributing to RMIS

Thank you for considering contributing to RMIS! While this repository is an open source application primarily for universities in Ethiopia, I welcome contributions and suggestions from rails community and anyone interested. This document will guide you through the process of making contributions.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork and clone the forked repository
  2. Create a new branch: git checkout -b branch-name
  3. Lint and test the project
  4. Add significant changes and product updates to the changelog
  5. Push to your fork and submit a pull request

How to Contribute

You can contribute to this project in various ways, such as:

  • Fixing bugs or issues
  • Adding new features or enhancements
  • Improving documentation
  • Optimizing code
  • Providing translations
  • Suggesting ideas or improvements

Code Style and Guidelines

While there are no strict guidelines for this project, maintaining code readability and consistency is appreciated. Please make sure your contributions align with the existing code style.

Submitting a Pull Request

When you are ready to submit your contribution, follow these steps:

  1. Create a new branch from the main branch with a descriptive name.
  2. Commit your changes and provide a clear and concise commit message.
  3. Push your branch to your forked repository.
  4. Submit a pull request to the main branch of the upstream repository.
  5. Ensure that you have included any necessary documentation or tests for your changes.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please let me know by opening an issue in GitHub. Provide as much detail as possible to help me understand and address the problem.

Need help?

First PR ever? Need help deciding which design pattern to use? Can't fix a flaky test? Let me know – I'm more than happy to help. Feel free to comment on the issue/PR or send me an email.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License. This means that your contributions will be available under the same license terms as the rest of the project. Make sure to read and understand the license terms before making any contributions.