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

Add a CONTRIBUTING.md ? #268

Closed
paul-hansen opened this issue Aug 8, 2023 · 2 comments · Fixed by #272
Closed

Add a CONTRIBUTING.md ? #268

paul-hansen opened this issue Aug 8, 2023 · 2 comments · Fixed by #272

Comments

@paul-hansen
Copy link
Contributor

Just a minor suggestion. A CONTRIBUTING.md or something along those lines might be helpful after running into these things that were non-obvious to me working on #257:

  • Why we have a Cargo.lock file
  • When should the Cargo.lock file be updated
  • Changelog should not be modified. Instead use ?? (something to do with release-please, I don't understand it yet)
  • How to run tests locally
    • run cargo test -p accesskit_windows in addition to cargo test
    • Note that some tests may fail if the window looses focus. Try running directly from terminal instead of from your IDEs terminal

If desired, I could make an initial draft based on these points, but if someone that works on the project regularly has time, they might have better knowledge of what should be in it.

@mwcampbell
Copy link
Contributor

I need to work on something else now, but I just wanted to say thanks for your suggestion, for bearing with us as we figure out how best to bring new contributors up to speed, and for your PR.

@DataTriny
Copy link
Member

Indeed this is a very good idea. Thanks for bringing it up. If you want to start a draft, I'll gladly help you. In fact this is the kind of documents best produced by people without inside knowledge.

BTW I think you already nailed the most important points!

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 a pull request may close this issue.

3 participants