Skip to content

Contribute

Jump to bottom
andydhancock edited this page Nov 16, 2023 · 1 revision

Contribute

We welcome contributions from the community! Whether you're fixing a bug, improving the documentation, or proposing new features, your help is appreciated. Here's how you can contribute to the LegaleseScript project.

Getting Started

Before you begin, you should have a basic understanding of the following:

  • Git and GitHub
  • Markdown (for documentation)
  • The principles of LegaleseScript (refer to the documentation)

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, you can use GitHub Issues to report them:

  • Navigate to the Issues tab of the LegaleseScript repository.
  • Check if the issue has already been reported.
  • If not, create a new issue and provide a clear description of the problem or feature request.

Contributing Code

We accept code contributions via GitHub Pull Requests (PRs). Here's the general process:

  • Fork the repository.
  • Create a new branch for your changes.
  • Implement your changes and commit them to your branch.
  • Push your branch to your fork.
  • Submit a PR from your fork's branch to the main repository.

Pull Request Guidelines

Ensure your PRs are as clear and concise as possible:

  • Provide a descriptive title for the PR.
  • Include a detailed description of the changes.
  • Reference any related issues.
  • Ensure your code adheres to the existing style to maintain the project's consistency.

Contributing to Documentation

Documentation is just as important as code! To contribute:

  • Clone the repository.
  • Make your changes to the documentation in Markdown.
  • Submit a PR with your changes.

Community Guidelines

We strive to maintain a welcoming and inclusive community. Please adhere to our Code of Conduct when interacting with the project and its members.

Recognition

Your contributions will be publicly acknowledged. We value each contribution, no matter how small.

Questions and Support

If you have any questions or need help with contributing, feel free to reach out to the maintainer or ask the community.

Conclusion

Contributions to LegaleseScript help improve the tool for everyone. Whether you're a seasoned developer or a first-time contributor, your input is welcome and greatly appreciated!

Thank you for being a part of our community!

Clone this wiki locally