Skip to content

Latest commit

 

History

History
50 lines (31 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

50 lines (31 loc) · 2.71 KB
Raw

Contributing Guidelines

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to OpenLib.cs, which are hosted in the BPDC ACM Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Please note that this repository is a curated list which means it's not a complete catalogue of everything.

Table Of Contents

How Can I Contribute?

How Can I Contribute?

Reporting Issues

This section guides you through submitting a issue, following these guidelines helps maintainers and the community understand your report 📝 and find related issues 🔎.

Before submitting an issue, please see GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title to identify the main underlying problem.
  • Specify the course which has the issue.
  • Explain the issue in detail using clear concise information.
  • Use tags such as typo, dead links, or maybe copyrighted material?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion, including new courses and minor improvements to existing lists. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Specify the course where you would like to add a suggestion.
  • Explain why this enhancement would be useful to most CS students.

Pull Requests

The process described here has several goals:

  • Maintain the quality of materials.
  • Fix typos in any of the materials.
  • Fix dead links that aren't useful to students anymore.
  • Engage the community in building towards the repo that would truly benefit everyone.

To add a new course, please use the template provided.

If you are not sure how to submit a pull request, learn how to, while the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you for additional changes before your pull request can be ultimately accepted.