Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 3.39 KB

Contributing

First, thank you for considering contributing to renoun! Your contributions help make renoun better for everyone.

Table of Contents

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

How to Contribute

1. Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue in the repository. When reporting a bug, please include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or logs.

2. Suggesting Enhancements

Feature requests and enhancements are welcome and appreciated. To suggest an improvement:

  • Open an issue in the repository.
  • Provide a clear and descriptive title.
  • Include a detailed description of the feature or enhancement.
  • Explain why this feature would be beneficial.

3. Submitting Pull Requests

Contributions are welcome, to submit a pull request:

  1. Fork the Repository: Click the "Fork" button at the top right of the renoun repository to create your own fork.

  2. Clone Your Fork:

    git clone https://github.com/souporserious/renoun.git

  3. Create a Branch:

    git checkout -b feature/your-feature-name

  4. Make Your Changes: Implement your feature or bug fix.

  5. Commit Your Changes:

    git commit -m "your feature description"

  6. Push to Your Fork:

    git push origin your-feature-name

  7. Open a Pull Request: Navigate to the original renoun repository and click the "Compare & pull request" button. Provide a clear description of your changes and submit the PR.

Contributor License Agreement (CLA)

In order to clarify the intellectual property license granted with Contributions from any person, we require contributors to sign a Contributor License Agreement (CLA) before their contributions can be merged.

How to Sign the CLA

  1. Review the CLA: Read through the Contributor License Agreement to understand the terms.

  2. Sign the CLA: This project uses the CLA Assistant GitHub Action which allows you to sign the CLA directly through GitHub when you open a pull request.

  3. Wait for Confirmation: Once the CLA is reviewed and approved, your contributions will be eligible for merging.

Important: Pull requests without a signed CLA will not be reviewed or merged.

Getting Help

If you need any assistance or have questions about contributing, feel free to reach out:

Thank you for your interest in contributing to renoun! Your support is greatly appreciated 🙏