Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

63 lines (39 loc) · 2.37 KB
Raw

Contributing

Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs by submitting an issue.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Submit a pull request to fix bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Submit a pull request to implement features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

Concordia could always use more documentation. If you have worked with the tool and found any of our documentation to be inaccurate or vague, please submit an issue or a pull request.

How to submit Feedback

The best way to send feedback is to file an issue at https://github.com/LibraryOfCongress/concordia/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Check out our Developers’ Guide for information about running your own copy of the site and making changes.

Contributing Changes

If you have work which you would like to share with the main project, GitHub has a guide for creating pull requests as part of their broader help site, which also includes instructions for performing common tasks using the Git command-line interface or various desktop interfaces.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. You should be able and willing to release your code under the same terms as the top-level LICENSE file
  2. The pull request should include tests.
  3. If the pull request adds functionality it should be described at a technical level in the code and and user-visible changes should be described in the main README