Skip to content

CONTRIBUTION.md

Latest commit

 

History

History
48 lines (30 loc) · 2.9 KB

CONTRIBUTION.md

File metadata and controls

48 lines (30 loc) · 2.9 KB
Raw

Contributing to APE Open Source Projects

Thank you for your interest in contributing to APE! We value the contributions of each member of the community and look forward to your innovative ideas and improvements. When contributing, please follow the APE Community Code of Conduct.

Issues

Feel free to submit issues and enhancement requests. For bug reports, feature requests, and discussions, please use Git Issues to communicate.

Contributing

We encourage contributions from everyone. To contribute:

  1. Fork the repo on GitHub.
  2. Clone the project to your machine.
  3. Commit changes to your branch.
  4. Push your work back to your fork.
  5. Submit a Pull Request for review.

Note: Ensure you merge the latest changes from "upstream" before making a pull request!

Good Java Practices

When contributing code, please adhere to the following good Java practices:

  • Code Style: Follow the Google Java Style Guide. This ensures consistency across the codebase and makes it easier for others to understand your code.
  • Documentation: All methods and classes should be documented using Javadoc. This includes a description of the method's purpose, parameters, return values, and any exceptions thrown. Good documentation is crucial for maintainability and ease of use.
  • Testing: Include unit tests for new features and bug fixes. We aim for high test coverage to ensure code quality and reliability. Use JUnit for testing your code.
  • Efficiency: Write efficient code; avoid unnecessary computation or memory usage.
  • Readability: Write readable and maintainable code. Use meaningful variable and method names, and keep methods short and focused.

Pull Request Guidelines

  • Code Review: Your pull request will be reviewed by the project maintainers. Be open to feedback and willing to make changes as needed.
  • Description: Provide a detailed description of the changes in your pull request. If it's related to an open issue, include a link to it in the description.
  • Testing: Your changes should pass all existing tests, and any new functionality should be accompanied by new tests.

Copyright and Licensing

APE is licensed under the Apache 2.0 license.

You retain the copyright of your contributions. However, by contributing to APE, you agree to license your contributions under the Apache 2.0 license. This ensures your contributions can be included in the main repository.

Include the Apache 2.0 license summary at the top of each file, along with the copyright information. If you are adding new files, include your name in the copyright notice.

FAQ

For more information and frequently asked questions, visit our FAQ page.