Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 2.42 KB
Raw

Contributing to PxWeb

Thank you for your interest in contributing to PxWeb! We welcome contributions from the community to help improve our project.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch from the main branch. Name your branch descriptively, indicating the purpose of your changes.
  4. Make your changes and ensure that the code follows the project's coding conventions.
  5. Test your changes thoroughly to ensure they work as expected.
  6. Commit your changes with a clear and descriptive commit message.
  7. Push your changes to your forked repository.
  8. Open a pull request against the main branch of the original repository.

3rd Party Components

While developing for this project, we aim to minimize the number of dependencies. This is to keep the project lightweight, maintainable, and to reduce potential security risks.

Before adding a new 3rd party component or library, please consider the following:

  1. Is the component necessary? Can the functionality be achieved without it?
  2. Is the component actively maintained? An unmaintained component can pose a security risk and may lack support.
  3. Does the component have a large community? Larger communities often mean more resources for troubleshooting and learning.
  4. Is the component's license compatible with our project?

If you believe a 3rd party component is necessary, please provide a justification in your pull request. The project maintainers will review and discuss the addition.

Code Review

All pull requests will be reviewed by the project maintainers. Please be patient and responsive during the review process. Feedback and suggestions may be provided to help improve the quality of your contribution.

Issue Tracking

If you encounter any issues or have ideas for improvements, please check the project's issue tracker on GitHub. If the issue or idea has not been reported yet, feel free to open a new issue.

Code of Conduct

This project and everyone participating in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

We appreciate your contributions and look forward to working with you!