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

Standardize file headers and provide example of "perfect source code file" #212

Open
2 tasks
krisnova opened this issue Dec 29, 2022 · 1 comment
Open
2 tasks
Labels
Good First Issue New to the project? Looking for something to get started with?

Comments

@krisnova
Copy link
Contributor

Right now all of our code is very disparate, some files have apache 2 headers, some do not, some have large amounts of comments, some are empty, etc, etc

This issue has 2 parts

  1. Document and provide an example of a "picture perfect" Aurae .rs file
  2. Begin working backwards from the example, and implement the required changes for each of our source files

Do we need to have clippy tags? If so, which ones are the "correct" ones to use?
Do we need to include an apache 2 header with the ascii art? if so can we please automate/add the headers globally.
Do we need documentation as in #211 everywhere? is there an example we should be using?

@krisnova krisnova added the Good First Issue New to the project? Looking for something to get started with? label Dec 29, 2022
@krisnova
Copy link
Contributor Author

See also: https://github.com/rust-lang/rustfmt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue New to the project? Looking for something to get started with?
Projects
None yet
Development

No branches or pull requests

1 participant