Skip to content

Latest commit

 

History

History
50 lines (28 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

50 lines (28 loc) · 1.46 KB
Raw

Contributing to Lampray

Thanks for helping make Lampray better! Follow this guide to learn how to contribute to Lampray.

1. Fork the Repository

Start by forking this repository to your GitHub account using the "Fork" button at the top right.

2. Clone the Repository

Clone your forked repository to your local machine.

3. Create a New Branch

Create a new branch for your work with a descriptive name.

4. Make Changes

Make your desired changes or improvements to the codebase.

5. Test

Ensure that your changes work as expected and that they don't introduce any new issues.

6. Commit

Commit your changes with a clear and concise commit message.

7. Push

Push your changes to your forked repository.

8. Create a Pull Request

  1. Go to the original repository and click on the "New Pull Request" button.
  2. Fill in the pull request title with the following format
    1. for new features, feat: your feature oneliner name
    2. for bugfixes or minor changes: fix: your bugfix oneline name
    3. for other kinds, see https://www.conventionalcommits.org/en/v1.0.0/#summary
  3. Follow the pull request template and fill in detailed description of your changes.

9. Discuss and Review

💬 Engage in discussions with the maintainers and the community about your pull request.

🤔 Be prepared to make any necessary adjustments based on feedback.

10. Merge

🎉 Once your pull request is reviewed and approved, it will be merged into the main branch.