How to Contribute

Sure! Here's a "How to Contribute" page for your documentation.

🤝 How to Contribute

We welcome contributions to PrevNames! Whether you're reporting bugs, suggesting new features, or submitting pull requests with code improvements, your help is always appreciated. Below is a guide on how to get involved.

Ways You Can Contribute

1. Reporting Issues

If you find a bug or encounter unexpected behavior while using PrevNames, please report it! When reporting issues, be sure to provide detailed information such as:

  • Steps to reproduce the issue

  • Error messages or logs (if applicable)

  • Expected vs. actual behavior

  • Screenshots (if possible)

2. Suggesting New Features

Have an idea to improve the module? We’d love to hear it! If you have a new feature or enhancement in mind, open an issue with a description of what the feature will do and how it will benefit the users.

3. Submitting Code Improvements

If you'd like to contribute code, here’s how you can help:

  • Bug Fixes: If you notice an issue in the code, feel free to fix it!

  • New Features: Implement new features or functionality.

  • Documentation: Help improve the documentation, fix typos, or clarify instructions.

How to Get Started

1. Fork the Repository

First, fork the repository to your GitHub account. This allows you to work on your changes independently without affecting the main project.

2. Clone Your Fork

Clone your forked repository to your local machine.

git clone https://github.com/your-username/prevnames.git

3. Create a New Branch

Create a new branch for your changes. Make sure the branch name describes the change or feature you're working on.

git checkout -b feature/my-awesome-feature

4. Make Your Changes

Make your changes locally, whether it’s fixing bugs, adding features, or improving the documentation.

5. Commit Your Changes

Once you're happy with your changes, commit them to your branch. Be sure to write a clear and concise commit message describing your changes.

git add .
git commit -m "Add new feature to track name history"

6. Push Your Changes

Push your changes back to your forked repository on GitHub.

git push origin feature/my-awesome-feature

7. Open a Pull Request

Open a pull request (PR) from your branch to the main repository. In the PR, describe what your changes do and reference any related issues if applicable.

We will review your pull request, and if everything looks good, we’ll merge it into the main codebase.

Code Guidelines

To maintain the quality and consistency of the codebase, please follow these guidelines:

  • Use ES6+ syntax: Use the latest JavaScript features where appropriate.

  • Keep it clean: Write clear, readable, and well-documented code.

  • Test your code: If you're adding a feature or fixing a bug, make sure the code works as expected. If possible, write tests for your changes.

Join the Conversation

If you need help, have questions, or want to chat about PrevNames, feel free to reach out! You can create an issue or join the discussion on the GitHub Discussions page.

📝 License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thanks for considering contributing to PrevNames! Your input and feedback make this module better for everyone. Happy coding! 🚀

PreviousEvent System

Last updated