sam/awl
sam/awl
1
0
Fork 1
Code Issues 5 Pull requests Projects Releases 28 Packages 4 Wiki Activity Actions
awl/docs/CONTRIBUTING.md
Sam Therapy a5980be3cc
All checks were successful
Mirror Push / mirror (push) Successful in 7s
Details
Test / test (stable) (push) Successful in 36s
Details
Test / test (oldstable) (push) Successful in 56s
Details
docs: Use the docs folder more 
Also rename it from doc to docs

Signed-off-by: Sam Therapy <sam@samtherapy.net>
2024-03-23 22:05:57 +01:00

2.3 KiB
Raw Blame History

Contributing to awl

First off, thank you! We appreciate your interest in wanting to contribute to awl.

If you like the project, spread the word! Help us grow by sharing the project with anyone you thing might be interested. Here are some ways you can help:

  • Star the project on GitHub
  • Share the project on social media
  • Tell your friends about the project

How to contribute

If you want to contribute to awl, you can do so by:

Reporting a bug

If you find a bug in awl, please open an issue on the project's issue tracker. When reporting a bug, please include as much information as possible, such as:

  • The version of awl you are using
  • The operating system you are using
  • The steps to reproduce the bug
  • Any error messages you received

Requesting a feature

If you have an idea for a feature you would like to see in awl, please open an issue on the project's issue tracker. When requesting a feature, please include as much information as possible, such as:

  • A description of the feature
  • Why you think the feature would be useful
  • Any other relevant information

Submitting a pull request

If you would like to contribute code to awl, you can do so by submitting a pull request. To submit a pull request, follow these steps:

  1. Fork the project on Git
  2. Create a new branch for your changes
  3. Make your changes
  4. Push your changes to your fork
  5. Open a pull request on the project's Git repository

When submitting a pull request, please include as much information as possible, such as:

  • A description of the changes you made
  • Why you made the changes
  • Any other relevant information

Alternatively, you can also contribute by sending an email to the project's mailing list. For more information about using Git over email, refer to git-send-email.io

Code Style

Before submitting a pull request, please run make lint to ensure your code adheres to the project's code style. Make sure that you have golangci-lint installed, that is our linter of choice.