Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create 📝 Documentation for Scribe Android #224

Closed
wants to merge 1 commit into from

Conversation

KesharwaniArpita
Copy link
Contributor

Contributor checklist


Description

This PR creates the documentation.yml for Scribe Android by adding clear guidelines for contributors. It builds the issue template for documentation-related contributions, ensuring consistency in how contributors propose improvements or updates to the project.

Changes:

  • Added a new issue template for documentation contributions
  • Ensured all contributors must agree to the Code of Conduct and search existing issues before submitting
  • Included fields for contributors to specify the topic and provide a detailed description of their documentation work
  • Added links to the Documentation Guidelines to help contributors follow best practices

Why: Clear and structured documentation is critical for open-source projects like Scribe Android. This template will streamline contributions and improve the quality and consistency of future documentation updates.

Related issue

Copy link

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Android rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflows within the PR checks do not indicate new errors in the files changed

  • The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

- type: markdown
attributes:
value: |
🔗 Please follow our [Documentation Guidelines](https://github.com/scribe-org/Scribe-Android/wiki/Documentation-Guidelines).
Copy link
Member

@andrewtavis andrewtavis Oct 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why a link to the GitHub wiki for this project is being included when this project doesn't have/use its wiki 🤔

@andrewtavis
Copy link
Member

@KesharwaniArpita I'm going to close this. If and when we do something, then the documentation will be autogenerated for the project via the docstrings of functions and classes. Yes we need to work on it, but this is not a priority over here at this time.

  • Please check before opening PRs that are not associated with an issue in the future.

@KesharwaniArpita
Copy link
Contributor Author

Sure @andrewtavis . I'll take care of that.I am so sorry for the inconvenience.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants