{"id":"b76a770664b88effa6c277b9093f7464176fd52709b1141ea1fb31dd9b358a66","type":"Contented","path":"/others/contributing","modifiedDate":1686373756200,"sections":["Others"],"fields":{"title":"Contributing Guidelines"},"html":"

Contributing Guidelines

\n
\n

Taken\nfrom BirthdayResearch/.github/CONTRIBUTING.md

\n
\n

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or\nadditional documentation, we greatly value feedback and contributions from our community.

\n

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary\ninformation to effectively respond to your bug report or contribution.

\n

Security issue notifications

\n

If you discover a potential security issue in this project we ask that you notify Birthday Research Security via our\nemail security@birthday.dev. Please do not create a public GitHub issue.

\n

Reporting Bugs/Feature Requests

\n

We welcome you to use the GitHub issue tracker to report bugs or suggest features.

\n

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already\nreported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

\n\n

Contributing via Pull Requests

\n

Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:

\n
    \n
  1. You are working against the latest source on the main branch.
    2. \n
  2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem\nalready.
    3. \n
  3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
    4. \n
\n

To send us a pull request, please:

\n
    \n
  1. Fork the repository.
    2. \n
  2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it\nwill be hard for us to focus on your change.
    3. \n
  3. Ensure local tests pass.
    4. \n
  4. Commit to your fork using clear commit messages.
    5. \n
  5. Send us a pull request, answering any default questions in the pull request interface.
    6. \n
  6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
    7. \n
\n

GitHub provides additional document on forking a repository and\ncreating a pull request.

\n

Finding contributions to work on

\n

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the\ndefault GitHub issue labels (feature/bug/duplicate/good first issue/question/wontfix), looking at any 'good first issue'\nissues is a great place to start.

\n

Licensing

\n

See the LICENSE file for our project's licensing.

","headings":[{"depth":1,"id":"contributing-guidelines","title":"Contributing Guidelines","children":[{"depth":2,"id":"security-issue-notifications","title":"Security issue notifications","children":[]},{"depth":2,"id":"reporting-bugsfeature-requests","title":"Reporting Bugs/Feature Requests","children":[]},{"depth":2,"id":"contributing-via-pull-requests","title":"Contributing via Pull Requests","children":[]},{"depth":2,"id":"finding-contributions-to-work-on","title":"Finding contributions to work on","children":[]},{"depth":2,"id":"licensing","title":"Licensing","children":[]}]}]}