Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

60 lines (41 loc) · 3.34 KB
Raw

Contributing to aardwolf

Contributors are always welcome! This guide aims to provide some pointers :D If you have any questions, reach us on #aardwolf-discussion:matrix.org and we'll happily answer them! We're happy to support your professional development.

Getting started

High level approach:

  1. Check out the development docs
  2. Find something to fix/improve (hint: the issues tagged with 'help wanted')
  3. Change code (Rust code lives in /src/, WebUI lives in /templates/)
  4. Run the app to verify (cargo run --bin aardwolf-server), ask for help, make changes until it works
  5. Open a PR (also can be done between 2. and 3. if you run into problems)

Contributions

All contributions to Aardwolf or its dependencies should be made in the form of GitHub pull requests (PR's). Each pull request will be reviewed by a core contributor (someone with permission to merge PR's) and either merged in the main tree or given feedback for changes that would be required. All contributions should follow this format, even those from core contributors.

Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.

Head over to Aardwolf Starter Issues to find good tasks to start with. If you come across words or jargon that do not make sense, please feel free to ask on #aardwolf-discussion:matrix.org. We will probably be working on a proper glossary at some point after we get a proper application running.

Pull Request Checklist

  • Branch from the master branch and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you may be asked to rebase your changes.

  • Commits should be as small as possible, while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).

  • If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review in #aardwolf-discussion:matrix.org.

  • Add tests relevant to the fixed bug or new feature. For a DOM change this will usually be a web platform test; for layout, a reftest. See our testing guide for more information.

For specific git instructions, see GitHub workflow 101. (( Github has the best documentation :P ))

Code of Conduct

We want all feel welcome so please be mindful of our Code of Conduct.

Communication

Most of the core contributors are on Riot/Matrix room #aardwolf-discussion:matrix.org

You can also join the aardwolf-development mailing list.