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

Improve Contribution documentation #319

Closed
elizalflores opened this issue May 25, 2024 · 1 comment · Fixed by #320
Closed

Improve Contribution documentation #319

elizalflores opened this issue May 25, 2024 · 1 comment · Fixed by #320
Labels
community Everything for/about/with contributors or other community topics… documentation Code or textual documentation/text-only work

Comments

@elizalflores
Copy link
Contributor

I believe the project README.md and CONTRIBUTING.md should include more clarifying information and directions for developers on how to contribute.

Currently there is further, nested documentation on how to contribute to the project located in the TinyWebEx project.

I plan to modify the README.md and CONTRIBUTING.md to help give more information about these additional guidelines.

@rugk
Copy link
Owner

rugk commented May 25, 2024

Sure do a PR; but from your description it is not really clear what you want to modify.

Note the big parts should be into the "nested" TinyWebEx contrib doc, as this applies to all extensions and I don't want to maintain that change in each extension. So maybe your PR should be done there, depending on the changes.

@rugk rugk added documentation Code or textual documentation/text-only work community Everything for/about/with contributors or other community topics… labels May 25, 2024
@rugk rugk closed this as completed in #320 Jun 8, 2024
rugk added a commit that referenced this issue Jun 8, 2024
[Fix Issue #319] Increase README clarity and references
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Everything for/about/with contributors or other community topics… documentation Code or textual documentation/text-only work
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants