Skip to content

Latest commit

 

History

History
113 lines (74 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

113 lines (74 loc) · 3.38 KB
Raw

Contributing to Memoir

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Memoir. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can I Contribute?

1. Reporting Bugs

If you find a bug, please report it by creating a new issue. Be sure to include:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the bug.
  • Any relevant logs, screenshots, or error messages.

2. Suggesting Enhancements

We welcome feature suggestions! If you have an idea that could improve Memoir, please open an issue and label it as a "Feature Request". Include:

  • A clear and descriptive title.
  • A detailed explanation of the enhancement.
  • The motivation for the enhancement.
  • Any relevant examples or use cases.

3. Submitting Pull Requests

  1. Fork the Repository: Create a personal fork of the repository on GitHub.

  2. Clone the Fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/Memoir-App.git
cd Memoir-App

  3. Create a Branch: Create a new branch to work on. Use a descriptive name.

    git checkout -b feature/your-feature-name

  4. Make Your Changes: Make changes to the codebase. Follow the coding standards and commit messages guidelines mentioned below.

  5. Commit Your Changes: Make sure your commit messages are clear and descriptive.

    git add .
git commit -m "Add feature X that does Y"

  6. Push to Your Fork: Push your changes to your fork on GitHub.

    git push origin feature/your-feature-name

  7. Create a Pull Request: Go to the original repository and create a pull request from your forked repository's branch. Provide a clear title and description of your changes.

  8. Code Review: Your pull request will be reviewed, and you may be asked to make changes. Please address feedback promptly.

  9. Merge: Once your pull request is approved, it will be merged into the main branch.

4. Coding Standards

  • Formatting: Follow the existing code style. This includes indentation, spacing, and comments.
  • Comments: Write meaningful comments to explain your code.
  • Commit Messages: Use clear and descriptive commit messages. For example:
    • Add feature X to do Y
    • Fix bug in feature Z

5. Code of Conduct

By participating in this project, you agree to abide by the Code of Conduct. Please be respectful and considerate in your interactions.

Development Setup

Prerequisites

  • [List any software, libraries, or tools that are needed to contribute]

Installation

  1. Clone the Repository:

    git clone https://github.com/[organization]/[repository-name].git
cd [repository-name]

  2. Install Dependencies:

    npm install

  3. Run the Development Server:

    npm run dev

Running Tests

If your project has tests, explain how to run them:

npm test

License

By contributing, you agree that your contributions will be licensed under the AGPL-3.0 license of this project.

Contact

If you have any questions or need further guidance, feel free to reach out by opening an issue or contacting the maintainers directly.