Skip to content

Latest commit

 

History

History
36 lines (21 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) · 1.31 KB
Raw

Contributing

We appreciate contributions of any kind. By participating in this project, you agree to abide by our code of conduct.

How to Contribute

Reporting Issues

To report bugs, suggest enhancements, or raise any other issues, please create a new issue in the GitHub repository. We will review your issue promptly.

Pull Requests

We love pull requests from everyone.

  1. Fork the repository to your GitHub account.

  2. Clone the forked repository to your local machine:

    git clone [email protected]:your-username/education-benchmarking-and-insights.git

  3. All changes should be based on the main branch.

  4. Make your changes, ensuring each commit has a clear and descriptive message summarising the purpose of the change.

  5. Push your changes to your fork.

  6. Open a pull request against the main branch of our repository.

  7. After submitting a pull request, our team will review your changes. Please be patient during this process and respond to any feedback or comments provided by our reviewers.

Tips for Successful Pull Request

  • Update README with any needed changes.
  • Ensure each commit has a clear and descriptive message summarising the purpose of the change. This helps us understand the rationale behind your modifications.
  • Follow our coding standards and conventions.