Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Be more explicit, that contributions are expected to follow code conventions #1458

Closed
wants to merge 1 commit into from
Closed

Be more explicit, that contributions are expected to follow code conventions #1458

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion www/Contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ JNA contains work from many developers. You're encouraged to contribute to both
- Fork the code from [github.com/java-native-access/jna](https://github.com/java-native-access/jna)
- Check out the code with `git clone [email protected]:username/jna.git`
- Ensure you can build the project with `ant dist test test-platform`
- Make your code changes, write tests, build
- Make your code changes, write tests, build. New code should follow the
conventions observable in the surrounding code/the codebase. Existing code
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please explicitly state the conventions you want, for example "Traditional Bean Java Naming conventions". Otherwise you're asking for an undefined Standard, as there is no declared linter, nor linting test within the Testing Pipeline.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Crain-32 See #1473. Would appreciate any input you have there.

should only be changed if the change is necessary. In general reformating
unrelated code is not necessary.
- Add entry to CHANGES.md describing the change
- Submit pull requests, forks and/or topical branches are encouraged.

Expand Down