Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 2.04 KB

File metadata and controls

46 lines (28 loc) · 2.04 KB

Contributing

We welcome contributions from the community, whether it's in the form of code, bug reports, feature requests, documentation improvements, or any other enhancements that can make the project more useful for everyone. Here's how you can contribute:

Getting Started

First, if you're new to GitHub or open-source contributing, it might be helpful to familiarize yourself with the basics of Git and GitHub. There are many excellent resources available online, including GitHub's own documentation.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for improving the project, please use the Issues section of the repository. Before submitting a new issue, please:

  • Check the existing issues to avoid duplicates.
  • Clearly describe the issue or suggestion, providing all necessary details.

Submitting Changes

If you'd like to submit a change to the project, such as a bug fix, a new feature, or a documentation update, please follow these steps:

  1. Fork the repository.
  2. Create a new branch in your fork for your changes.
  3. Make your changes in your branch.
  4. Commit your changes with clear, descriptive commit messages.
  5. Push your changes to your fork.
  6. Submit a pull request to the main repository.

Please adhere to the following best practices in your contributions:

  • Ensure your code follows the project's coding conventions.
  • Update the documentation to reflect your changes if necessary.

Pull Request Guidelines

When submitting a pull request, please:

  • Describe what your code does and why you've made these changes.
  • Mention any issues your pull request addresses (if applicable).
  • Ensure your pull request is based on the latest version of the main branch to avoid merge conflicts.

Questions?

If you have any questions or need further guidance, feel free to reach out to the project maintainers or ask in the project's Issues section.

Thank you for contributing to the Urantia Papers open-source data project!